NSX-T Data Center Global Policy API Guide

NSX-T Data Center 3.1.0

Overview

Introduction

This guide is for the NSX-T Data Center Global Manager API endpoint and is only relevant for environments using NSX-T Federation. For all other use cases please look at the at the NSX-T Data Center Manager API guide.

Like for the local manager of NSX-T Data Center, in case of Federation the global manager provides a programmatic API to automate management activities.

The Global Manager aims to manage centrally the configuration of multiple NSX-T deployments (also called Local Managers) as part of NSX-T Federation. In those environments both the Global Manager and the Local Managers API endpoints are available, but objects created and managed (CRUD) from the Global Manager should only be managed at this level.

The Global Manager follows the same data-structure than the NSX-T Data Center Local Manager. 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.

API Policy: Changes, Deprecations and Removals

VMware NSX Data Center may add new features in both major and minor releases as designed as an increment of the "x" digit and "y" digit of the x.y.z product version. These new features may lead to additional APIs or non-breaking changes to existing APIs to support the new feature.

At least one year prior to the removal of any deprecated API VMware will document the APIs that are planned to be removed in the NSX Data Center API Guide by marking them with "deprecated" in this document. If available, replacement APIs will also be documented.

API removal can be in a major or minor release but not in maintenance releases.

NSX Data Center APIs marked as "experimental" or that are not documented in the NSX Data Center API Guide are not subject to this policy. This indicates that the API may be changed or removed without notice in a future NSX-T Data Center release.

Request Failures

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, 429 Too Many Requests, 500 Internal Server Error, 503 Service Unavailable. Where other errors may be returned, the type of error is indicated in the API method description. All errors are documented in the API Errors section.

Request Authentication

Most API calls require authentication. This API supports several different authentication schemes, which are documented in this section. 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 credentials of user admin with password admin, include the following header with the request:

The following cURL command will authenticate to the manager using basic authentication and will issue a GET request for the top-level global-infra object.

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

For example:

Note: the -k argument instructs cURL to skip verifying the manager's self-signed X.509 certificate. It is more secure to verify that the server's certificate is signed by a Certificate Authority (CA) that you trust. To do that, omit the -k argument and use the --cacert <ca-file> option, where <ca-file> is a PEM-formatted file containing the CA certificate to trust.

For example:

Additional cURL examples below use the -k flag, but you can always substitute the --rootca <ca-file> argument for additional security.

In the above examples, USERNAME may be:

1. A local user name. For example, "admin".
2. A remote user name, of the form "user@domain", for example, "[email protected]". The domain must match a domain for a configured VIDM identity source or a configured LDAP identity source.

Note: in earlier versions of NSX, in order to authenticate to VIDM, it was required that you provide an authentication header of the form "Authorization: Remote base64-encoded-username-and-password". This is no longer required, but still functions for backward compatibility.

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.

If the user is a remote user, append "@domain" to the username, for example, "[email protected]". The domain must match a domain for a configured VIDM identity source or a configured LDAP identity source.

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.

For example:

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:

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:

Authentication using an X.509 certificate and a Principal Identity

NSX supports using an X.509 client certificate for authentication. The certificate is associated with a principal identity (a short name, similar to a username), and that principal identity can be bound to an NSX role. This is useful for automated processes or scripts that perform NSX API calls, and has the advantage that a user password does not need to be stored with the script.

For information on how to import a certificate and set up a principal identity, see the section "Add a Role Assignment or Principal Identity" in the NSX-T Administration Guide.

To use the client certificate to authenticate, your client must have access to the certificate and its associated private key. How to specify client authentication depends on the client you are using. For example, with curl, you use the --key argument to give the filename containing the private key and the --cert argument to give the filename containg the public certificate.

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.

Optimistic Concurrency Control and the _revision property

Overview

In order to prevent one client from overwriting another client's updates, NSX-T employs a technique called optimistic concurrency control.

All REST payloads contain a property named "_revision". This is an integer that is incremented each time an existing resource is updated. Clients must provide this property in PUT requests and it must match the current _revision or the update will be rejected. This guards against the following situation:

Client 1 reads resource A.

Client 2 reads resource A.

Client 1 replaces the display_name property of resource A and does a PUT to replace the resource.

Client 2 replaces is different property of resource A and attempts to perform a PUT operation.

Without optimistic concurrency control, Client 2's update would overwrite Client 1's update to the display_name property. Instead, Client 2 receives a 409 Conflict error. To recover, Client 2 must fetch the resource again, apply the change, and perform a PUT.

Exceptions for /policy APIs

APIs whose URI begins with /policy have slightly different behavior. For those APIs, the _revision property must not be set when PUT is used to create a new resource. Once the resource is created, however, the _revision property must be provided with PUT operations.

PATCH and _revision for /policy APIs

APIs whose URI begins with /policy support the PATCH operation. Those APIs do not require that the _revision property be provided. A client can, however, request that the _revision property be checked when it is performing a PATCH in the /infra path. To do this, the client should pass the query parameter enforce_revision_check, e.g. PATCH /infra?enforce_revision_check=true.

Partial patching of objects is a feature supported by NSX that allows patching a subset of properties of any object. This behavior needs to be explicitly enabled. When partial patching is disabled (default behavior), the entire payload of object is expected to be provided in both PUT and PATCH operations for the /policy APIs.

In order to perform partial patching of existing objects using PATCH operation, partial patching should be enabled using either one of the following approach:

1. System-wide partial patch configuration
   Partial patch can be enabled/disabled in the system by using the Partial Patch Config api (i.e. PATCH /policy/api/v1/system-config/nsx-partial-patch-config) with sample request payload.
   
   { "enable_partial_patch": "true" }
   Default is 'false'.
   Note: If the API request header has 'nsx-enable-partial-patch' parameter, then the header takes precedence over this system-wide configuration.
2. Header parameter (request level configuration)
   Partial patch can also be enabled/disabled using API request header parameter. This will override the system-wide configuration for a particular request.
   To enable partial patch, use 'nsx-enable-partial-patch=true'
   To disable partial patch, use 'nsx-enable-partial-patch=false'
   If this parameter is not passed in header, the system level configuration will be considered for Partial Patch operation. This header parameter will be considered only for PATCH requests. For other requests (e.g. PUT, POST etc.), this header parameter will be ignored.

Some important considerations/notes on Partial Patch:

1. Array properties will be replaced entirely in partial patch.
2. If PATCH api is executed on a non-existing object, a new object will be created after performing all applicable validations.
3. There are cases where properties of an object are inter-dependent on each other e.g. username and password, IP address and thumbprint etc. In such cases, the partial patch request expects all such inter-dependent fields to be provided (either all or none).
4. Partial patch is not supported for 'Infra' object.
5. Certain types like Labels, Security Policies (for the 'rules' attribute) and Services have special handling for certain attributes in PATCH request. This behavior will not be overridden by Partial Patch.
   For instance, specifying rules on Security policies as a part of the PATCH invocation merges the specified rules with the existing rules. For full replacement of rules, PUT operation needs to be performed on the Security Policy.
6. Partial patch will not work for properties accepting polymorphic types if the specified value has a type that is different from that of the existing value.

API Rate Limiting

The NSX-T API service has three settings that control the rate of incoming API requests:

1) A per-client rate limit, in requests per second. If a client makes more requests than this limit in one second, the API server will refuse to service the API request and will return an HTTP 429 Too Many Requests Error. By default, this limit is 100 requests per second.

2) A per-client concurrency limit. This is the maximum number of outstanding requests that a client can have. For example, a client can open multiple connections to NSX-T and submit operations on each connection. When this limit is exceeded, the server returns a 429 Too Many Requests error to the client. By default, this limit is 40 concurrent requests.

3) An overall maximum number of concurrent requests. This is the maximum number of API requests that can be in process on the server. If the server is at this limit, additional requests will be refused and the HTTP error 503 Service Unavailable will be returned to the client. By default, this limit is 199 concurrent requests.

The first two limits exist to provide some level of fairness across multiple clients of NSX-T, and are intended to prevent one greedy client from preventing other clients from making API requests.

The last limit is the server's way of protecting itself against an unintentional (or intentional) denial of service attack.

Each manager enforces the rate limit independently of the other managers. For example, in a 3-node cluster, each manager has a maximum concurrency of 199 requests, but across the cluster there may be a maximum of 199 * 3 = 597 concurrent requests.

While it is possible to configure these rate limits using the /api/v1/node/services/http API, it is not recommended. Instead, you should design your API client to gracefully deal with situations where limits are exceeded.

Designing API client code to work gracefully with rate limits

One approach is to build in throttling into the client code so that it never sends more than 100 requests in a given second and that it never has more than 40 concurrent requests in flight.

However, there isn't any way to ensure that the overall concurrency limits are never hit. That is because there may be other clients calling APIs, driving up the load on the server. API clients need to check for the HTTP error 503 Service Unavailable. In the event a 503 error is received, the simplest strategy is to insert a delay, possibly with an exponential backoff in the event that server load is high.

There are open-source libraries than can help you implement this retry/backoff behavior, such as Google's Retry helper in its Python google-api-core library. For an example of using this library with the NSX-T APIs, see https://github.com/vmware-samples/nsx-t/blob/master/python/basics/rate-limits.py

OpenAPI Specification of NSX-T APIs

You can download OpenAPI specifications for the Global Policy NSX-T API at the following URLs:

NSX-T Global Policy API:

• GET https://<global-manager>/global-manager/api/v1/spec/openapi/nsx_global_policy_api.yaml
• GET https://<global-manager>/global-manager/api/v1/spec/openapi/nsx_global_policy_api.json

Federation: Infra

Federation: Infra: Federation Configuration

Federation: Infra: Global Managers

Federation: Infra: Onboarding

Federation: Infra: Sites

Federation: Local Manager

Federation: Local Manager: Full Synchronization

Management Plane API: NSX Component Administration

Management Plane API: NSX Component Administration: Appliance Management

Policy

Policy: Authorization

Policy: Authorization: Object Permissions

Policy: Infra: Certificates

Policy: Infra: Certificates: Certificates

Policy: Infra: Certificates: Certification Revocation List

Policy: Infra

Policy: Infra: Constraints

Policy: Infra: Domains

Policy: Infra: Domains: Domain

Policy: Infra: Domains: Domain Deployment Maps

Policy: Infra: Enforcement Points

Policy: Infra: Federation

Policy: Infra: Hierarchical API

Policy: Infra: Labels

Policy: Infra: Realized State

Policy: Infra: Sites

Policy: Inventory

Policy: Inventory: Context Profiles

Policy: Inventory: Groups

Policy: Inventory: Groups: Group Members

Policy: Inventory: Groups: Groups

Policy: Inventory: Services

Policy: Networking: Connectivity: Segment

Policy: Networking: Connectivity: Segment: Intersite-Forwarder

Policy: Networking: Connectivity: Segment: MAC Table

Policy: Networking: Connectivity: Segment: Ports

Policy: Networking: Connectivity: Segment: Ports: MAC Table

Policy: Networking: Connectivity: Segment: Ports: State

Policy: Networking: Connectivity: Segment: Segment Profiles

Policy: Networking: Connectivity: Segment: Segment Profiles: Monitoring Profile Binding

Policy: Networking: Connectivity: Segment: State

Policy: Networking: Connectivity: Segment: Statistics

Policy: Networking: Connectivity: Segment: Tep Table

Policy: Networking: Connectivity: Segments

Policy: Networking: Connectivity: Segments: Ports

Policy: Networking: Connectivity: Segments: Segment Profiles

Policy: Networking: Connectivity: Segments: Segment Profiles: Discovery Profile Binding

Policy: Networking: Connectivity: Segments: Segment Profiles: IP Discovery Profiles

Policy: Networking: Connectivity: Segments: Segment Profiles: MAC Discovery Profiles

Policy: Networking: Connectivity: Segments: Segment Profiles: Monitoring Profile Binding

Policy: Networking: Connectivity: Segments: Segment Profiles: QOS Profile Binding

Policy: Networking: Connectivity: Segments: Segment Profiles: QOS Profiles

Policy: Networking: Connectivity: Segments: Segment Profiles: Security Profile Binding

Policy: Networking: Connectivity: Segments: Segment Profiles: Segment Security Profile Binding

Policy: Networking: Connectivity: Segments: Segment Profiles: Segment Security Profiles

Policy: Networking: Connectivity: Segments: Segment Profiles: Spoofguard Profiles

Policy: Networking: Connectivity: Segments: Segments

Policy: Networking: Connectivity: Segments: Segments (Fixed)

Policy: Networking: Connectivity: Segments: State

Policy: Networking: Connectivity: Segments: Statistics

Policy: Networking: Connectivity: Tier-0 Gateways

Policy: Networking: Connectivity: Tier-0 Gateways: ARP Proxies

Policy: Networking: Connectivity: Tier-0 Gateways: Inter-Site

Policy: Networking: Connectivity: Tier-0 Gateways: Interfaces

Policy: Networking: Connectivity: Tier-0 Gateways: Interfaces: ARP Proxies

Policy: Networking: Connectivity: Tier-0 Gateways: Interfaces: ARP Table

Policy: Networking: Connectivity: Tier-0 Gateways: Interfaces: DAD State

Policy: Networking: Connectivity: Tier-0 Gateways: Interfaces: Interfaces

Policy: Networking: Connectivity: Tier-0 Gateways: Interfaces: Statistics

Policy: Networking: Connectivity: Tier-0 Gateways: Routing

Policy: Networking: Connectivity: Tier-0 Gateways: Routing: BGP

Policy: Networking: Connectivity: Tier-0 Gateways: Routing: Community Lists

Policy: Networking: Connectivity: Tier-0 Gateways: Routing: Forwarding Table

Policy: Networking: Connectivity: Tier-0 Gateways: Routing: Prefix List

Policy: Networking: Connectivity: Tier-0 Gateways: Routing: Route Maps

Policy: Networking: Connectivity: Tier-0 Gateways: Routing: Routing Table

Policy: Networking: Connectivity: Tier-0 Gateways: Routing: State

Policy: Networking: Connectivity: Tier-0 Gateways: Routing: Static Routes

Policy: Networking: Connectivity: Tier-0 Gateways: Routing: Static Routes BFD Peers

Policy: Networking: Connectivity: Tier-0 Gateways: Tier-0 Deployment Maps

Policy: Networking: Connectivity: Tier-0 Gateways: Tier-0 Gateways

Policy: Networking: Connectivity: Tier-0 Gateways: Tier-0 Locale Services

Policy: Networking: Connectivity: Tier-1 Gateways

Policy: Networking: Connectivity: Tier-1 Gateways: ARP Proxies

Policy: Networking: Connectivity: Tier-1 Gateways: Interfaces

Policy: Networking: Connectivity: Tier-1 Gateways: Interfaces: ARP Proxies

Policy: Networking: Connectivity: Tier-1 Gateways: Interfaces: ARP Table

Policy: Networking: Connectivity: Tier-1 Gateways: Interfaces: DAD State

Policy: Networking: Connectivity: Tier-1 Gateways: Interfaces: Interfaces

Policy: Networking: Connectivity: Tier-1 Gateways: Interfaces: Statistics

Policy: Networking: Connectivity: Tier-1 Gateways: Routing

Policy: Networking: Connectivity: Tier-1 Gateways: Routing: Forwarding Table

Policy: Networking: Connectivity: Tier-1 Gateways: Routing: State

Policy: Networking: Connectivity: Tier-1 Gateways: Routing: Static Routes

Policy: Networking: Connectivity: Tier-1 Gateways: Tier-1 Gateways

Policy: Networking: Connectivity: Tier-1 Gateways: Tier-1 Locale Services

Policy: Networking: IP Management: DHCP

Policy: Networking: IP Management: DHCP: DHCP Relay Configs

Policy: Networking: IP Management: DHCP: DHCP Server Configs

Policy: Networking: IP Management: DHCP: DHCP Static Bindings

Policy: Networking: IP Management: DHCP: DHCP Static Bindings: Segments Bindings

Policy: Networking: IP Management: DHCP: DHCP Static Bindings: Segments Bindings (Fixed)

Policy: Networking: IP Management: DNS: DNS Forwarder

Policy: Networking: IP Management: DNS: DNS Forwarder: DNS Zones

Policy: Networking: IP Management: DNS: DNS Forwarder: Tier-0 Gateways

Policy: Networking: IP Management: DNS: DNS Forwarder: Tier-1 Gateways

Policy: Networking: Network Services

Policy: Networking: Network Services: Forwarding Policies

Policy: Networking: Network Services: NAT: Rules

Policy: Networking: Network Services: NAT: Rules: Tier-0 Gateways

Policy: Networking: Network Services: NAT: Rules: Tier-1 Gateways

Policy: Networking: Network Services: NAT

Policy: Networking: Network Services: NAT: Statistics

Policy: Networking: Networking Profiles

Policy: Networking: Networking Profiles: BFD Profiles

Policy: Networking: Networking Profiles: EVPN Tenant Configuration

Policy: Networking: Networking Profiles: Gateway QOS Profiles

Policy: Networking: Networking Profiles: IPV6 DAD Profiles

Policy: Networking: Networking Profiles: IPV6 NDRA Profiles

Policy: Operations

Policy: Operations: Compliance

Policy: Operations: Finetuning

Policy: Operations: IPFIX

Policy: Operations: IPFIX: Firewall IPFIX Collectors

Policy: Operations: IPFIX: Firewall IPFIX Profiles

Policy: Operations: IPFIX: Switch IPFIX Collectors

Policy: Operations: IPFIX: Switch IPFIX Profiles

Policy: Operations: Port Mirroring

Policy: Security: East West Security: Distributed Firewall

Policy: Security: East West Security: Distributed Firewall: Rules

Policy: Security: East West Security: Distributed Firewall: Settings

Policy: Security: East West Security: Distributed Firewall: Settings: Firewall Scheduler

Policy: Security: East West Security: Distributed Firewall: Statistics

Policy: Security: North South Security: Gateway Firewall

Policy: Security: North South Security: Gateway Firewall: Rules

Policy: Security: North South Security: Gateway Firewall: Statistics

Policy: Security: North South Security: Gateway Firewall: Tier-0 Gateways

Policy: Security: North South Security: Gateway Firewall: Tier-1 Gateways

Policy: Security: Security Profiles

Policy: Security: Security Profiles: Cpu Memory Thresholds Profiles

Policy: Security: Security Profiles: DNS Security Profile Bindings

Policy: Security: Security Profiles: DNS Security Profiles

Policy: Security: Security Profiles: Flood Protection Profile Binding

Policy: Security: Security Profiles: Flood Protection Profiles

Policy: Security: Security Profiles: Monitoring Profile Binding

Policy: Security: Security Profiles: Session Timer Profile Binding

Policy: Security: Security Profiles: Session Timer Profile Bindings

Policy: Security: Security Profiles: Session Timer Profiles

Policy: System Configuration

Policy: System Configuration: NSX Partial Patch

Policy: Task

Search

Search: Search API

System Administration: Configuration: Fabric: Nodes

System Administration: Configuration: Fabric: Nodes: DNS

System Administration: Configuration: Fabric: Nodes: Fabric Nodes

System Administration: Configuration: Fabric: Nodes: File Store

System Administration: Configuration: Fabric: Nodes: Logs

System Administration: Configuration: Fabric: Nodes: Network Interfaces

System Administration: Configuration: Fabric: Nodes: Network Interfaces: Routing

System Administration: Configuration: Fabric: Nodes: Services

System Administration: Configuration: Fabric: Nodes: Services: Log Insight

System Administration: Configuration: Fabric: Nodes: Services: NSX Platform Client

System Administration: Configuration: Fabric: Nodes: Services: NTP

System Administration: Configuration: Fabric: Nodes: Services: Node Management

System Administration: Configuration: Fabric: Nodes: Services: SNMP

System Administration: Configuration: Fabric: Nodes: Services: SSH

System Administration: Configuration: Fabric: Nodes: Services: Syslog

System Administration: Configuration: Fabric: Nodes: Services: Tasks

System Administration: Configuration: Fabric: Nodes: Services: Upgrade Agent

System Administration: Configuration: Fabric: Nodes: Settings

System Administration: Configuration: Fabric: Nodes: Support-Bundle

System Administration: Configuration: Fabric: Nodes: Transport Nodes

System Administration: Configuration: Fabric: Nodes: User Management

System Administration: Configuration: Fabric: Nodes: User Management: Authentication Policy

System Administration: Configuration: Fabric: Nodes: User Management: Users

System Administration: Configuration: NSX Intelligence

System Administration: Configuration: NSX Intelligence: Appliance Management

System Administration: Configuration: NSX Managers: API Services

System Administration: Configuration: NSX Managers: API Services: API Request Batching

System Administration: Configuration: NSX Managers: API Services: Configuration

System Administration: Configuration: NSX Managers: Clusters

System Administration: Configuration: NSX Managers: Clusters: Cluster Certificate

System Administration: Configuration: NSX Managers: Clusters: Cluster Configuration

System Administration: Configuration: NSX Managers: Clusters: Cluster Virtual IP

System Administration: Configuration: NSX Managers: Hardening

System Administration: Configuration: NSX Managers: Hardening: Mandatory Access Control

System Administration: Configuration: NSX Managers

System Administration: Configuration: NSX Managers: Manager Configuration

System Administration: Configuration: NSX Managers: Nodes

System Administration: Configuration: NSX Managers: Nodes: Manager Configuration

System Administration: Configuration: NSX Managers: Nodes: Manager Rabbitmq Configuration

System Administration: Configuration: NSX Managers: Nodes: Services

System Administration: Configuration: NSX Managers: Nodes: Services: Async Replicator Service

System Administration: Configuration: NSX Managers: Nodes: Services: Cluster Manager Service

System Administration: Configuration: NSX Managers: Nodes: Services: Global Manager Service

System Administration: Configuration: NSX Managers: Nodes: Services: HTTP Service

System Administration: Configuration: NSX Managers: Nodes: Services: Install Upgrade Service

System Administration: Configuration: NSX Managers: Nodes: Services: Management Plane Bus Service

System Administration: Configuration: NSX Managers: Nodes: Services: Manager Service

System Administration: Configuration: NSX Managers: Nodes: Services: NSX Message Service

System Administration: Configuration: NSX Managers: Nodes: Services: Search Service

System Administration: Configuration: NSX Managers: Nodes: Services: Telemetry Service

System Administration: Configuration: NSX Managers: Nodes: Services: User Interface Service

System Administration: Lifecycle Management: Backup Restore Management

System Administration: Lifecycle Management: Backup Restore Management: Backup

System Administration: Lifecycle Management: Backup Restore Management: Restore

System Administration: Lifecycle Management: Upgrade

System Administration: Lifecycle Management: Upgrade: Bundles

System Administration: Lifecycle Management: Upgrade: Eula

System Administration: Lifecycle Management: Upgrade: Group

System Administration: Lifecycle Management: Upgrade: History

System Administration: Lifecycle Management: Upgrade: Nodes

System Administration: Lifecycle Management: Upgrade: Plan

System Administration: Lifecycle Management: Upgrade: Status

System Administration: Lifecycle Management: Upgrade: Upgrade Units

System Administration: Monitoring: Dashboards

System Administration: Monitoring: Dashboards: UI Views

System Administration: Monitoring: Dashboards: Widget Configuration

System Administration: Monitoring

System Administration: Monitoring: Error Resolver

System Administration: Monitoring: Logs

System Administration: Monitoring: Logs: Core Dumps

System Administration: Settings

System Administration: Settings: Licenses

System Administration: Settings: Support Bundle

System Administration: Settings: User Management

System Administration: Settings: User Management: Access Token

System Administration: Settings: User Management: LDAP Identity Sources

System Administration: Settings: User Management: Roles

System Administration: Settings: User Management: Users

System Administration: Settings: User Management: Vidm Configuration

API Types

ALGTypeServiceEntry (schema)

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.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
alg	The Application Layer Gateway (ALG) protocol The Application Layer Gateway (ALG) protocol. Please note, protocol NBNS_BROADCAST and NBDG_BROADCAST are deprecated. Please use UDP protocol and create L4 Port Set type of service instead.	string	Required Enum: ORACLE_TNS, FTP, SUN_RPC_TCP, SUN_RPC_UDP, MS_RPC_TCP, MS_RPC_UDP, NBNS_BROADCAST, NBDG_BROADCAST, TFTP
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Required Minimum items: 1 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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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: IPProtocolServiceEntry, IGMPTypeServiceEntry, ICMPTypeServiceEntry, ALGTypeServiceEntry, L4PortSetServiceEntry, EtherTypeServiceEntry, NestedServiceServiceEntry
source_ports		array of PortElement	Maximum items: 15
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

AbstractSpace (schema)

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.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
connectivity_strategy	Connectivity strategy used by this tenant The connectivity strategy is deprecated. Use default layer3 rule, /infra/domains/default/security-policies/default-layer3-security-policy/rules/default-layer3-rule. 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 WHITELIST_ENABLE_LOGGING - Whitelising with logging enabled BLACKLIST_ENABLE_LOGGING - Blacklisting with logging enabled NONE - No default rules are added.	string	Deprecated Enum: WHITELIST, BLACKLIST, WHITELIST_ENABLE_LOGGING, BLACKLIST_ENABLE_LOGGING, 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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

AcceptableComponentVersion (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
acceptable_versions	List of component versions	array of string	Required
component_type	Node type	string	Required Enum: HOST, EDGE, CCP, MP
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
resource_type	Must be set to the value AcceptableComponentVersion	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

AcceptableComponentVersionList (schema)

Name	Description	Type	Notes
results	Acceptable version whitelist for different components	array of AcceptableComponentVersion	Required

Action (schema)

Reaction Action

Reaction Action is the action to take when the stipulated criteria specified
in the event exist over the source. Some example actions include:
- Notify Admin (or VMC's SRE) via email.
- Populate a specific label with the IPSec VPN Session.
- Remove the IPSec VPN Session from a specific label.
This is an abstract type. Concrete child types:
PatchResources
SetFields

Name	Description	Type	Notes
resource_type	Resource Type Reaction Action resource type.	string	Required Enum: PatchResources, SetFields

ActionableResource (schema)

Resources managed during restore process

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
ip_address	A resource reference on which actions can be performed	string
resource_type	Must be set to the value ActionableResource	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ActionableResourceListRequestParameters (schema)

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
included_fields	Comma separated list of fields that should be included in query result	string
instruction_id	Id of the instruction set whose instructions are to be returned	string	Required
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

ActionableResourceListResult (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	List results	array of ActionableResource	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

ActiveDirectoryIdentitySource (schema)

An Active Directory identity source service

An identity source service that runs Microsoft Active Directory. The service allows selected user accounts defined in Active Directory to log into and access NSX-T.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
alternative_domain_names	Additional domains to be directed to this identity source After parsing the "user@domain", the domain portion is used to select the LDAP identity source to use. Additional domains listed here will also be directed to this LDAP identity source. In Active Directory these are sometimes referred to as Alternative UPN Suffixes.	array of string
base_dn	DN of subtree for user and group searches The subtree of the LDAP identity source to search when locating users and groups.	string	Required
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
domain_name	Authentication domain name The name of the authentication domain. When users log into NSX using an identity of the form "user@domain", NSX uses the domain portion to determine which LDAP identity source to use.	string	Required
id	Unique identifier of this resource	string	Sortable
ldap_servers	LDAP servers for this identity source The list of LDAP servers that provide LDAP service for this identity source. Currently, only one LDAP server is supported.	array of IdentitySourceLdapServer	Maximum items: 1
resource_type	Must be set to the value ActiveDirectoryIdentitySource	string	Required Enum: ActiveDirectoryIdentitySource, OpenLdapIdentitySource
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

AddressBindingEntry (schema)

Combination of IP-MAC-VLAN binding

An address binding entry is a combination of the IP-MAC-VLAN binding for
a logical port. The address bindings can be obtained via various methods
like ARP snooping, DHCP snooping etc. or by user configuration.

Name	Description	Type	Notes
binding	Combination of IP-MAC-VLAN binding	PacketAddressClassifier
binding_timestamp	Timestamp of binding Timestamp at which the binding was discovered via snooping or manually specified by the user	EpochMsTimestamp
source	Address binding source Source from which the address binding entry was obtained	AddressBindingSource	Default: "UNKNOWN"

AddressBindingSource (schema)

Source from which the address binding is obtained

Name	Description	Type	Notes
AddressBindingSource	Source from which the address binding is obtained	string	Enum: INVALID, UNKNOWN, USER_DEFINED, ARP_SNOOPING, DHCP_SNOOPING, VM_TOOLS, ND_SNOOPING, DHCPV6_SNOOPING, VM_TOOLS_V6

AdvanceClusterRestoreInput (schema)

Name	Description	Type	Notes
id	Unique id of an instruction (as returned by the GET /restore/status call) for which input is to be provided	string	Required Readonly
resources	List of resources for which the instruction is applicable.	array of SelectableResourceReference	Required

AdvanceClusterRestoreRequest (schema)

Name	Description	Type	Notes
data	List of instructions and their associated data	array of AdvanceClusterRestoreInput	Required

AggregateDNSForwarderStatistics (schema)

Aggregate of DNS forwarder statistics

Aggregate of DNS forwarder statistics across enforcement points.

Name	Description	Type	Notes
intent_path	String path of the DNS forwarder intent String path of the DNS forwarder intent.	string	Required
statistics_per_enforcement_point	List of DNS forwarder statistics per enforcement point List of DNS forwarder statistics per enforcement point.	array of DNSForwarderStatisticsPerEnforcementPoint (Abstract type: pass one of the following concrete types) NsxTDNSForwarderStatistics	Readonly

AggregateDNSForwarderStatus (schema)

Aggregate of DNS forwarder status

Aggregate of DNS forwarder status across enforcement points.

Name	Description	Type	Notes
intent_path	String path of the DNS forwarder intent String path of the DNS forwarder intent.	string	Required
status_per_enforcement_point	List of DNS forwarder status per enforcement point List of DNS forwarder status per enforcement point.	array of DNSForwarderStatusPerEnforcementPoint (Abstract type: pass one of the following concrete types) NsxTDNSForwarderStatus	Readonly

AggregatePolicyDnsAnswer (schema)

Aggregate of DNS forwarder nslookup answer

Aggregate of DNS forwarder nslookup answer across enforcement points.

Name	Description	Type	Notes
dns_answer_per_enforcement_point	List of DNS forwarder nslookup answer per enforcement point List of DNS forwarder nslookup answer per enforcement point.	array of PolicyDnsAnswerPerEnforcementPoint	Readonly
intent_path	String path of the DNS forwarder intent String path of the DNS forwarder intent.	string	Required

AggregatePolicyRuntimeInfo (schema)

Aggregate of PolicyRuntimeInfoPerEP

Aggregate of PolicyRuntimeInfoPerEP across Enforcement Points.

Name	Description	Type	Notes
intent_path	String Path of the intent object Intent path of object, forward slashes must be escaped using %2F.	string	Required Readonly

AggregatedDataCounter (schema)

Name	Description	Type	Notes
rx_bytes		DataCounter	Readonly
rx_packets		DataCounter	Readonly
tx_bytes		DataCounter	Readonly
tx_packets		DataCounter	Readonly

AggregatedDataCounterEx (schema)

Name	Description	Type	Notes
dropped_by_security_packets		PacketsDroppedBySecurity	Readonly
mac_learning		MacLearningCounters	Readonly
rx_bytes		DataCounter	Readonly
rx_packets		DataCounter	Readonly
tx_bytes		DataCounter	Readonly
tx_packets		DataCounter	Readonly

AggregatedLogicalRouterPortCounters (schema)

Name	Description	Type	Notes
last_update_timestamp	Timestamp when the data was last updated; unset if data source has never updated the data.	EpochMsTimestamp	Readonly
rx		LogicalRouterPortCounters	Readonly
tx		LogicalRouterPortCounters	Readonly

ApiError (schema)

Detailed information about an API Error

Name	Description	Type	Notes
details	Further details about the error	string
error_code	A numeric error code	integer
error_data	Additional data about the error	object
error_message	A description of the error	string
module_name	The module name where the error occurred	string
related_errors	Other errors related to this error	array of RelatedApiError

ApiRequestBody (schema)

API Request Body

API Request Body is an Event Source that represents an API request body that
is being reveived as part of an API. Supported Request Bodies are those received
as part of a PATCH/PUT/POST request.

Name	Description	Type	Notes
resource_pointer	Resource Pointer Regex path representing a regex expression on resources. This regex is used to identify the request body(ies) that is/are the source of the Event. For instance: specifying "Lb* | /infra/tier-0s/vmc/ipsec-vpn-services/default" as a source means that ANY resource starting with Lb or ANY resource with "/infra/tier-0s/vmc/ipsec-vpn-services/default" as path would be the source of the event in question.	string	Required
resource_type	Must be set to the value ApiRequestBody	string	Required Enum: ResourceOperation, ApiRequestBody

ApiServiceConfig (schema)

Configuration of the API service

Properties that affect the configuration of the NSX API service.

Name	Description	Type	Notes
basic_authentication_enabled	Enable or disable basic authentication Identifies whether basic authentication is enabled or disabled in API calls.	boolean	Default: "True"
cipher_suites	Cipher suites used to secure contents of connection The TLS cipher suites that the API service will negotiate.	array of CipherSuite	Minimum items: 1
client_api_concurrency_limit	Client API rate limit in calls The maximum number of concurrent API requests that will be serviced for a given authenticated client. If the number of API requests being processed exceeds this limit, new API requests will be refused and a 503 Service Unavailable response will be returned to the client. To disable API concurrency limiting, set this value to 0.	integer	Minimum: 0 Default: "40"
client_api_rate_limit	Client API rate limit in calls per second The maximum number of API requests that will be serviced per second for a given authenticated client. If more API requests are received than can be serviced, a 429 Too Many Requests HTTP response will be returned. To disable API rate limiting, set this value to 0.	integer	Minimum: 0 Default: "100"
connection_timeout	NSX connection timeout NSX connection timeout, in seconds. To disable timeout, set to 0.	integer	Minimum: 0 Maximum: 2147483647 Default: "30"
cookie_based_authentication_enabled	Enable or disable cookie-based authentication Identifies whether cookie-based authentication is enabled or disabled in API calls. When cookie-based authentication is disabled, new sessions cannot be created via /api/session/create.	boolean	Default: "True"
global_api_concurrency_limit	Global API rate limit in calls The maximum number of concurrent API requests that will be serviced. If the number of API requests being processed exceeds this limit, new API requests will be refused and a 503 Service Unavailable response will be returned to the client. To disable API concurrency limiting, set this value to 0.	integer	Minimum: 0 Default: "199"
lockout_immune_addresses	IP addresses which are not subject to lockout on failed login attempts The list of IP addresses which are not subjected to a lockout on failed login attempts.	array of IPAddress
protocol_versions	TLS protocol versions The TLS protocol versions that the API service will negotiate.	array of ProtocolVersion	Minimum items: 1
redirect_host	Hostname/IP to use in redirect headers Host name or IP address to use for redirect location headers, or empty string to derive from current request. To disable, set redirect_host to the empty string ("").	HostnameOrIPv4AddressOrEmptyString	Default: ""
session_timeout	NSX session inactivity timeout	integer	Minimum: 0 Maximum: 2147483647 Default: "1800"

ApplianceManagementSuppressRedirectQueryParameter (schema)

Name	Description	Type	Notes
suppress_redirect	Suppress redirect status if applicable Do not return a redirect HTTP status.	boolean	Default: "False"

ApplianceManagementTaskListResult (schema)

Appliance management task query results

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Task property results	array of ApplianceManagementTaskProperties	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

ApplianceManagementTaskProperties (schema)

Appliance management task properties

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
async_response_available	True if response for asynchronous request is available	boolean	Readonly
cancelable	True if this task can be canceled	boolean	Readonly
description	Description of the task	string	Readonly
details	Details about the task if known	object	Readonly
end_time	The end time of the task in epoch milliseconds	EpochMsTimestamp	Readonly
id	Identifier for this task	string	Readonly Pattern: "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}_[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$"
message	A message describing the disposition of the task	string	Readonly
progress	Task progress if known, from 0 to 100	integer	Readonly Minimum: 0 Maximum: 100
request_method	HTTP request method	string	Readonly
request_uri	URI of the method invocation that spawned this task	string	Readonly
start_time	The start time of the task in epoch milliseconds	EpochMsTimestamp	Readonly
status	Current status of the task	ApplianceManagementTaskStatus	Readonly
user	Name of the user who created this task	string	Readonly

ApplianceManagementTaskQueryParameters (schema)

Name	Description	Type	Notes
fields	Fields to include in query results Comma-separated field names to include in query result	string
request_method	Request method(s) to include in query result Comma-separated request methods to include in query result	string	Pattern: "^(=|!=|~|!~)?.+$"
request_path	Request URI path(s) to include in query result Comma-separated request paths to include in query result	string	Pattern: "^(=|!=|~|!~)?.+$"
request_uri	Request URI(s) to include in query result Comma-separated request URIs to include in query result	string	Pattern: "^(=|!=|~|!~)?.+$"
status	Status(es) to include in query result Comma-separated status values to include in query result	string	Pattern: "^(=|!=|~|!~)?.+$"
user	Names of users to include in query result Comma-separated user names to include in query result	string	Pattern: "^(=|!=|~|!~)?.+$"

ApplianceManagementTaskStatus (schema)

Current status of the appliance management task

Name	Description	Type	Notes
ApplianceManagementTaskStatus	Current status of the appliance management task	string	Enum: running, error, success, canceling, canceled, killed

ApplicationConnectivityStrategy (schema)

Application specific connectivity strategy

Allows more granular policies for application workloads

Name	Description	Type	Notes
application_connectivity_strategy	Application connectivity strategy App connectivity strategies	string	Required Enum: ALLOW_INTRA, ALLOW_EGRESS
default_application_rule_id	Default rule ID associated with the application_connectivity_strategy Based on the value of the app connectivity strategy, a default rule is created for the security policy. The rule id is internally assigned by the system for this default rule.	integer	Readonly
logging_enabled	Enable logging flag Flag to enable packet logging. Default is disabled.	boolean	Default: "False"

ArpHeader (schema)

Name	Description	Type	Notes
dst_ip	The destination IP address	IPv4Address	Required
op_code	Arp message type This field specifies the nature of the Arp message being sent.	string	Required Enum: ARP_REQUEST, ARP_REPLY Default: "ARP_REQUEST"
src_ip	The source IP address This field specifies the IP address of the sender. If omitted, the src_ip is set to 0.0.0.0.	IPv4Address

ArpSnoopingConfig (schema)

ARP Snooping Configuration

Contains ARP snooping related configuration.

Name	Description	Type	Notes
arp_binding_limit	Maximum number of ARP bindings Number of arp snooped IP addresses Indicates the number of arp snooped IP addresses to be remembered per LogicalPort. Decreasing this value, will retain the latest bindings from the existing list of address bindings. Increasing this value will retain existing bindings and also learn any new address bindings discovered on the port until the new limit is reached.	int	Minimum: 1 Maximum: 256 Default: "1"
arp_snooping_enabled	Is ARP snooping enabled or not Indicates whether ARP snooping is enabled	boolean	Default: "True"

ArpTableRequestParameters (schema)

Routes request parameters

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
edge_path	Policy path of edge node Policy path of edge node. Edge node must be member of enforcement point. Edge path is required when interface specified is either service or loopback interface.	string
enforcement_point_path	Enforcement point path String Path of the enforcement point. When not specified, routes from all enforcement-points are returned. This property is required for retrieving routes in CSV format.	string
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

AttachedInterfaceEntry (schema)

Attached interface information for Bare metal server

The Attached interface is only effective for the segment port on Bare metal server.

Name	Description	Type	Notes
app_intf_name	The name of application interface	string	Required
default_gateway	Gateway IP	IPAddress
migrate_intf	Interface name to migrate IP configuration on migrate_intf will migrate to app_intf_name. It is used for Management and Application sharing the same IP.	string
routing_table	Routing rules	array of string

Attribute (schema)

Attributes

Attribute specific to a partner. There attributes are passed on to the partner appliance and is opaque to the NSX Manager. The Attributes used by the partner applicance.

Name	Description	Type	Notes
attribute_type	Attributetype. Attribute Type can be of any of the allowed enum type.	string	Enum: IP_ADDRESS, PORT, PASSWORD, STRING, LONG, BOOLEAN
display_name	Display name Attribute display name string value.	string
key	key Attribute key string value.	string	Required
read_only	read only Read only Attribute cannot be overdidden by service instance/deployment.	boolean	Default: "False"
value	value Attribute value string value.	string

AttributeVal (schema)

Attribute values of realized type

Contains type specific properties of generic realized entity

Name	Description	Type	Notes
data_type	Datatype of property represented by this attribute Datatype of the property	string	Required Readonly Enum: STRING, DATE, INTEGER, BOOLEAN
key	Key for the attribute value Attribute key	string
multivalue	multivalue flag If attribute has a single value or collection of values	boolean	Readonly
values	List of values for the attribute List of attribute values	array of string	Readonly

AuthenticationPolicyProperties (schema)

Configuration of authentication policies for the NSX node

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
api_failed_auth_lockout_period	Lockout period in seconds Once a lockout occurs, the account remains locked out of the API for this time period. Only applies to NSX Manager nodes. Ignored on other node types.	integer	Minimum: 0 Default: "900"
api_failed_auth_reset_period	Period, in seconds, for authentication failures to trigger lockout In order to trigger an account lockout, all authentication failures must occur in this time window. If the reset period expires, the failed login count is reset to zero. Only applies to NSX Manager nodes. Ignored on other node types.	integer	Minimum: 0 Default: "900"
api_max_auth_failures	Number of authentication failures that trigger API lockout Only applies to NSX Manager nodes. Ignored on other node types.	integer	Minimum: 0 Default: "5"
cli_failed_auth_lockout_period	Lockout period in seconds Once a lockout occurs, the account remains locked out of the CLI for this time period. While the lockout period is in effect, additional authentication attempts restart the lockout period, even if a valid password is specified.	integer	Minimum: 0 Default: "900"
cli_max_auth_failures	Number of authentication failures that trigger CLI lockout	integer	Minimum: 0 Default: "5"
minimum_password_length	Minimum number of characters required in account passwords	integer	Minimum: 8 Default: "8"

AuthenticationScheme (schema)

Name	Description	Type	Notes
scheme_name	Authentication scheme name	string	Required

AutoRds (schema)

Auto assigned Route Distinguishers

This object holds auto assigned route distinguishers for Layer 2 and Layer 3 configurations.

Name	Description	Type	Notes
l2_auto_rds	List of layer 2 Auto assigned Route Distinguisher	array of L2AutoRD
l3_auto_rd	Layer 3 Auto assigned Route Distinguisher This field is auto assigned by the system. The auto RD seed is populated when user does not assign a route_distinguisher field in the gateway.	string

Axes (schema)

Axes of a graph

Represents X and Y axes of a graph. For a multi-graph, the same axes are shared by all the graphs.

Name	Description	Type	Notes
x_label	Label for X axis of a graph	Label
y_label	Label for Y axis of a graph	Label

BackupConfiguration (schema)

Configuration for taking manual/automated backup

Name	Description	Type	Notes
after_inventory_update_interval	A number of seconds after a last backup, that needs to pass, before a topology change will trigger a generation of a new cluster/node backups. If parameter is not provided, then changes in a topology will not trigger a generation of cluster/node backups.	integer	Minimum: 300 Maximum: 86400
backup_enabled	true if automated backup is enabled	boolean	Default: "False"
backup_schedule	Set when backups should be taken - on a weekly schedule or at regular intervals.	BackupSchedule (Abstract type: pass one of the following concrete types) IntervalBackupSchedule WeeklyBackupSchedule
inventory_summary_interval	The minimum number of seconds between each upload of the inventory summary to backup server.	integer	Minimum: 30 Maximum: 3600 Default: "240"
passphrase	Passphrase used to encrypt backup files. Passphrase used to encrypt backup files. The passphrase specified must be at least 8 characters in length and must contain at least one lowercase, one uppercase, one numeric character and one special character (any other non-space character).	string	Pattern: "^$|^(?=.*[a-z])(?=.*[A-Z])(?=.*\d)(?=.*[^a-zA-Z\d\s]).{8,}$"
remote_file_server	The server to which backups will be sent.	RemoteFileServer	Required

BackupFrameRequestParameters (schema)

Backup Frame Request Parameters

Parameters (site_id, etc), that describes a backup/restore frame

Name	Description	Type	Notes
frame_type	Frame type This attribute is used to indicate the service on current site or other site for which backup is handled in a frame. LOCAL_LOCAL_MANAGER corresponds to local LM of the site. LOCAL_MANAGER cprresponds to LM of other site.	string	Readonly Enum: GLOBAL_MANAGER, LOCAL_MANAGER, LOCAL_LOCAL_MANAGER, NSX_INTELLIGENCE Default: "LOCAL_LOCAL_MANAGER"
site_id	Site ID Site ID of LM site, which will be supported in a frame	string	Default: "localhost"

BackupOperationHistory (schema)

Past backup operation details

Name	Description	Type	Notes
cluster_backup_statuses	Statuses of previous cluser backups	array of BackupOperationStatus
inventory_backup_statuses	Statuses of previous inventory backups	array of BackupOperationStatus
node_backup_statuses	Statuses of previous node backups	array of BackupOperationStatus

BackupOperationStatus (schema)

Backup operation status

Name	Description	Type	Notes
backup_id	Unique identifier of a backup	string	Required
end_time	Time when operation was ended	EpochMsTimestamp
error_code	Error code	string	Enum: BACKUP_NOT_RUN_ON_MASTER, BACKUP_SERVER_UNREACHABLE, BACKUP_AUTHENTICATION_FAILURE, BACKUP_PERMISSION_ERROR, BACKUP_TIMEOUT, BACKUP_BAD_FINGERPRINT, BACKUP_GENERIC_ERROR
error_message	Error code details	string
start_time	Time when operation was started	EpochMsTimestamp
success	True if backup is successfully completed, else false	boolean	Required

BackupOverview (schema)

Backup overview

Data for a single backup/restore card

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
backup_config	Backup configuration Configuration to generate a manual/automated backup	BackupConfiguration	Required
backup_operation_history	Last backup status Status of the last backup execution per component	BackupOperationHistory	Required
current_backup_operation_status	Current backup status Backup status decribes type, phase, success/failure and time of a | latest backup execution	CurrentBackupOperationStatus	Required
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
restore_status	Current restore status Status of restore process executing/executed on appliance	ClusterRestoreStatus	Required
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	List of timestamps of backed-up cluster files	array of ClusterBackupInfo	Required Readonly
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

BackupOverviewRequestParameters (schema)

Backup overview request parameters

Parameters, that REST API client needs to provide, in order to get data for
a backup/restore card with or without a list of generated backups.

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
frame_type	Frame type This attribute is used to indicate the service on current site or other site for which backup is handled in a frame. LOCAL_LOCAL_MANAGER corresponds to local LM of the site. LOCAL_MANAGER cprresponds to LM of other site.	string	Readonly Enum: GLOBAL_MANAGER, LOCAL_MANAGER, LOCAL_LOCAL_MANAGER, NSX_INTELLIGENCE Default: "LOCAL_LOCAL_MANAGER"
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
show_backups_list	Need a list of backups True to request a list of backups	boolean	Default: "True"
site_id	UUID of the site UUID of LM site, which will be supported in a frame	string	Default: "localhost"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

BackupSchedule (schema)

Abstract base type for Weekly or Interval Backup Schedule

This is an abstract type. Concrete child types:
IntervalBackupSchedule
WeeklyBackupSchedule

Name	Description	Type	Notes
resource_type	Schedule type	string	Required Enum: WeeklyBackupSchedule, IntervalBackupSchedule

BackupUiFramesInfo (schema)

Name	Description	Type	Notes
api_endpoint	prefix to be used for api call	string	Required Readonly Enum: global-manager, nsxapi, ica
frame_type	Type of service, for which backup is handled	string	Required Readonly Enum: GLOBAL_MANAGER, LOCAL_MANAGER, LOCAL_LOCAL_MANAGER, NSX_INTELLIGENCE
site_id	Id of the site	string	Required Readonly
site_version	Version of the site	string	Required Readonly

BackupUiFramesInfoList (schema)

Name	Description	Type	Notes
backup_frames_list	List of backup frames(and metadata) to be displayed in UI	array of BackupUiFramesInfo	Required Readonly

BaseConsolidatedStatusPerEnforcementPoint (schema)

Base class for ConsolidatedStatusPerEnforcementPoint

Consolidated Realized Status Per Enforcement Point.
This is an abstract type. Concrete child types:
ConsolidatedStatusNsxT
ConsolidatedStatusPerEnforcementPoint

Name	Description	Type	Notes
alarm	Alarm Information Details Alarm information details.	PolicyRuntimeAlarm	Readonly
consolidated_status	Consolidated Realized Status Consolidated Realized Status of an Intent object per enforcement point.	ConsolidatedStatus	Readonly
enforcement_point_id	Enforcement Point Id Enforcement Point Id.	string	Readonly
enforcement_point_path	Enforcement point Path Policy Path referencing the enforcement point where the info is fetched.	string	Readonly
resource_type		string	Required
site_path	Site Path The site where this enforcement point resides.	string	Readonly

BaseEndpoint (schema)

An endpoint to be used in redirection rule

Represents an endpoint which will be used as subject in rule.
It is a polymorphic type object which can be either of the types -
1. Virtual
2. Logical
We have 2 separate objects representing these 2 types.
VirtualEndPoint for Virtual type and ServiceInstanceEndpoint
for Logical.
This is an abstract type. Concrete child types:
ServiceInstanceEndpoint
VirtualEndpoint

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 BaseEndpoint	string	Required Enum: VirtualEndpoint, ServiceInstanceEndpoint
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
target_ips	IP addresses to redirect the traffic to IPs where either inbound or outbound traffic is to be redirected.	array of IPInfo	Required Minimum items: 1 Maximum items: 1
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

BaseListRequestParameters (schema)

Routes request parameters

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
enforcement_point_path	Enforcement point path String Path of the enforcement point. When not specified, routes from all enforcement-points are returned. This property is required for retrieving routes in CSV format.	string
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

BasePolicyServiceInstance (schema)

Represents an instance of partner Service and its configuration

Represents an instance of partner Service and its configuration.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
deployment_mode	Deployment Mode Deployment mode specifies how the partner appliance will be deployed i.e. in HA or standalone mode.	string	Enum: STAND_ALONE, ACTIVE_STANDBY Default: "ACTIVE_STANDBY"
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
partner_service_name	Name of Partner Service Unique name of Partner Service in the Marketplace	string	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 BasePolicyServiceInstance	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
transport_type	Transport Type Transport to be used while deploying Service-VM.	string	Enum: L2_BRIDGE, L3_ROUTED Default: "L2_BRIDGE"
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

BaseRule (schema)

A rule represent base properties for ,dfw, forwarding, redirection rule

A rule indicates the action to be performed for various types of traffic flowing between workload 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.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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. Along with paths we support IP Address of type IPv4 and IPv6. IP Address can be in one of the format(CIDR, IP Address, Range of IP Address). 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	Maximum items: 128
destinations_excluded	Negation of destination groups If set to true, the rule gets applied on all the groups that are NOT part of the destination groups. If false, the rule applies to the destination groups	boolean	Default: "False"
direction	Direction Define direction of traffic.	string	Enum: IN, OUT, IN_OUT Default: "IN_OUT"
disabled	Flag to disable the rule Flag to disable the rule. Default is enabled.	boolean	Default: "False"
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
ip_protocol	IPv4 vs IPv6 packet type Type of IP packet that should be matched while enforcing the rule. The value is set to IPV4_IPV6 for Layer3 rule if not specified. For Layer2/Ether rule the value must be null.	string	Enum: IPV4, IPV6, IPV4_IPV6
is_default	Default rule flag A flag to indicate whether rule is a default rule.	boolean	Readonly
logged	Enable logging flag Flag to enable packet logging. Default is disabled.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
notes	Text for additional notes on changes Text for additional notes on changes.	string	Maximum length: 2048
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
profiles	Layer 7 service profiles Holds the list of layer 7 service profile paths. These profiles accept attributes and sub-attributes of various network services (e.g. L4 AppId, encryption algorithm, domain name, etc) as key value pairs.	array of string	Maximum items: 128
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value BaseRule	string
rule_id	Unique rule ID This is a unique 4 byte positive number that is assigned by the system. This rule id is passed all the way down to the data path. The first 1GB (1000 to 2^30) will be shared by GM and LM with zebra style striped number space. For E.g 1000 to (1Million -1) by LM, (1M - 2M-1) by GM and so on.	integer	Readonly
scope	The list of policy paths where the rule is applied LR/Edge/T0/T1/LRP etc. Note that a given rule can be applied on multiple LRs/LRPs.	array of string	Maximum items: 128
sequence_number	Sequence number of the this Rule This field is used to resolve conflicts between multiple Rules under Security or Gateway Policy for a Domain If no sequence number is specified in the payload, a value of 0 is assigned by default. If there are multiple rules with the same sequence number then their order is not deterministic. If a specific order of rules is desired, then one has to specify unique sequence numbers or use the POST request on the rule entity with a query parameter action=revise to let the framework assign a sequence number	int	Minimum: 0
service_entries	Raw services In order to specify raw services this can be used, along with services which contains path to services. This can be empty or null.	array of ServiceEntry (Abstract type: pass one of the following concrete types) ALGTypeServiceEntry EtherTypeServiceEntry ICMPTypeServiceEntry IGMPTypeServiceEntry IPProtocolServiceEntry L4PortSetServiceEntry NestedServiceServiceEntry	Maximum items: 128
services	Names of services 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	Maximum items: 128
source_groups	Source group paths We need paths as duplicate names may exist for groups under different domains. Along with paths we support IP Address of type IPv4 and IPv6. IP Address can be in one of the format(CIDR, IP Address, Range of IP Address). 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	Maximum items: 128
sources_excluded	Negation of source groups If set to true, the rule gets applied on all the groups that are NOT part of the source groups. If false, the rule applies to the source groups	boolean	Default: "False"
tag	Tag applied on the rule User level field which will be printed in CLI and packet logs.	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

BaseRuleListResult (schema)

Paged Collection of Rules

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

BaseTier0Interface (schema)

Tier-0 interface configuration

Tier-0 interface configuration for external connectivity.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 BaseTier0Interface	string
subnets	IP address and subnet specification for interface Specify IP address and network prefix for interface.	array of InterfaceSubnet	Required Minimum items: 1
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

BasicAuthenticationScheme (schema)

Name	Description	Type	Notes
password	Password to authenticate with	string	Required
scheme_name	Authentication scheme name	string	Required Enum: basic
username	User name to authenticate with	string	Required Pattern: "^.+$"

BatchParameter (schema)

Options that affect how batch operations are processed

Name	Description	Type	Notes
atomic	transactional atomicity for the batch of requests embedded in the batch list use this flag if you want transactional atomicity	boolean	Default: "False"

BatchRequest (schema)

A set of operations to be performed in a single batch

Name	Description	Type	Notes
continue_on_error	Flag to decide if we will continue processing subsequent requests in case of current error for atomic = false.	boolean	Default: "True"
requests		array of BatchRequestItem

BatchRequestItem (schema)

A single request within a batch of operations

Name	Description	Type	Notes
body		object
method	method type(POST/PUT/DELETE/UPDATE) http method type	string	Required Enum: GET, POST, PUT, DELETE, PATCH
uri	Internal uri of the call relative uri (path and args), of the call including resource id (if this is a POST/DELETE), exclude hostname and port and prefix, exploded form of parameters	string	Required

BatchResponse (schema)

The reponse to a batch operation

Name	Description	Type	Notes
has_errors	errors indicator Indicates if any of the APIs failed	boolean
results	Bulk list results	array of BatchResponseItem	Required
rolled_back	indicates if all items were rolled back. Optional flag indicating that all items were rolled back even if succeeded initially	boolean

BatchResponseItem (schema)

A single respose in a list of batched responses

Name	Description	Type	Notes
body	object returned by api object returned by api	object
code	object returned by api http status code	integer	Required
headers	object returned by api The headers returned by the API call	object

BfdProfile (schema)

Bidirectional Forwarding Detection configuration for BGP peers

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
interval	Time interval between heartbeat packets in milliseconds Time interval between heartbeat packets in milliseconds.	int	Minimum: 50 Maximum: 60000 Default: "500"
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
multiple	Declare dead multiple Declare dead multiple. Number of times heartbeat packet is missed before BFD declares the neighbor is down.	int	Minimum: 2 Maximum: 16 Default: "3"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 BfdProfile	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

BfdProfileListResult (schema)

Paged Collection of BfdProfile

Paged Collection of BfdProfile.

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Bfd Profile List Results Bfd Profile list results.	array of BfdProfile	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

BgpAddressFamily (schema)

Name	Description	Type	Notes
in_prefix_count	Count of in prefixes Count of in prefixes	integer	Readonly
out_prefix_count	Count of out prefixes Count of out prefixes	integer	Readonly
type	BGP address family type BGP address family type	string	Required Readonly Enum: IPV4_UNICAST, VPNV4_UNICAST, IPV6_UNICAST, L2VPN_EVPN

BgpBfdConfig (schema)

BFD configuration for BGP peers

Name	Description	Type	Notes
enabled	Flag to enable BFD cofiguration Flag to enable BFD cofiguration.	boolean	Default: "False"
interval	Time interval between heartbeat packets in milliseconds Time interval between heartbeat packets in milliseconds.	int	Minimum: 50 Maximum: 60000 Default: "500"
multiple	Declare dead multiple Declare dead multiple. Number of times heartbeat packet is missed before BFD declares the neighbor is down.	int	Minimum: 2 Maximum: 16 Default: "3"

BgpGracefulRestartConfig (schema)

BGP Graceful Restart Configuration

Configuration field to hold BGP restart mode and timer.

Name	Description	Type	Notes
mode	BGP Graceful Restart Configuration Mode If mode is DISABLE, then graceful restart and helper modes are disabled. If mode is GR_AND_HELPER, then both graceful restart and helper modes are enabled. If mode is HELPER_ONLY, then helper mode is enabled. HELPER_ONLY mode is the ability for a BGP speaker to indicate its ability to preserve forwarding state during BGP restart. GRACEFUL_RESTART mode is the ability of a BGP speaker to advertise its restart to its peers.	string	Enum: DISABLE, GR_AND_HELPER, HELPER_ONLY Default: "HELPER_ONLY"
timer	BGP Graceful Restart Timer Configuration field to hold BGP restart timers.	BgpGracefulRestartTimer

BgpGracefulRestartTimer (schema)

BGP Graceful Restart Timers

Configuration field to hold BGP restart timers

Name	Description	Type	Notes
restart_timer	BGP Graceful Restart Timer Maximum time taken (in seconds) for a BGP session to be established after a restart. This can be used to speed up routing convergence by its peer in case the BGP speaker does not come back up after a restart. If the session is not re-established within this timer, the receiving speaker will delete all the stale routes from that peer.	integer	Minimum: 1 Maximum: 3600 Default: "180"
stale_route_timer	BGP Stale Route Timer Maximum time (in seconds) before stale routes are removed from the RIB (Routing Information Base) when BGP restarts.	integer	Minimum: 1 Maximum: 3600 Default: "600"

BgpNeighborConfig (schema)

BGP neighbor config

Contains information necessary to configure a BGP neighbor.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
allow_as_in	Flag to enable allowas_in option for BGP neighbor	boolean	Default: "False"
bfd	BFD configuration for failure detection BFD configuration for failure detection. BFD is enabled with default values when not configured.	BgpBfdConfig
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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
graceful_restart_mode	BGP Graceful Restart Configuration Mode If mode is DISABLE, then graceful restart and helper modes are disabled. If mode is GR_AND_HELPER, then both graceful restart and helper modes are enabled. If mode is HELPER_ONLY, then helper mode is enabled. HELPER_ONLY mode is the ability for a BGP speaker to indicate its ability to preserve forwarding state during BGP restart. GRACEFUL_RESTART mode is the ability of a BGP speaker to advertise its restart to its peers.	string	Enum: DISABLE, GR_AND_HELPER, HELPER_ONLY
hold_down_time	Wait time in seconds before declaring peer dead Wait time in seconds before declaring peer dead.	int	Minimum: 1 Maximum: 65535 Default: "180"
id	Unique identifier of this resource	string	Sortable
in_route_filters	Prefix-list or route map path for IN direction Specify path of prefix-list or route map to filter routes for IN direction. This property is deprecated, use route_filtering instead. Specifying different values for both properties will result in error.	array of string	Deprecated Maximum items: 1
keep_alive_time	Interval between keep alive messages sent to peer Interval (in seconds) between keep alive messages sent to peer.	int	Minimum: 1 Maximum: 65535 Default: "60"
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
maximum_hop_limit	Maximum number of hops allowed to reach BGP neighbor Maximum number of hops allowed to reach BGP neighbor.	int	Minimum: 1 Maximum: 255 Default: "1"
neighbor_address	Neighbor IP Address	IPAddress	Required
out_route_filters	Prefix-list or route map path for OUT direction Specify path of prefix-list or route map to filter routes for OUT direction. When not specified, a built-in prefix-list named 'prefixlist-out-default' is automatically applied. This property is deprecated, use route_filtering instead. Specifying different values for both properties will result in error.	array of string	Deprecated Maximum items: 1
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
password	Password Specify password for BGP neighbor authentication. Empty string ("") clears existing password.	string	Minimum length: 0 Maximum length: 20
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
remote_as_num	4 Byte ASN of the neighbor in ASPLAIN Format	string	Required
resource_type	Must be set to the value BgpNeighborConfig	string
route_filtering	Enable address families and route filtering in each direction Enable address families and route filtering in each direction.	array of BgpRouteFiltering	Maximum items: 2
source_addresses	Source IP Addresses for BGP peering Source addresses should belong to Tier0 external or loopback interface IP Addresses . BGP peering is formed from all these addresses. This property is mandatory when maximum_hop_limit is greater than 1.	array of IPAddress	Maximum items: 8
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

BgpNeighborConfigListRequestParameters (schema)

Routing Config 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
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

BgpNeighborConfigListResult (schema)

Paged collection of BGP Neighbor Configs

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	BGP neighbor configs list results	array of BgpNeighborConfig	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

BgpNeighborRouteDetailsCsvRecord (schema)

BGP neighbor route details

BGP neighbor learned/advertised route details.

Name	Description	Type	Notes
as_path	AS path BGP AS path attribute.	string	Readonly
local_pref	Local preference BGP Local Preference attribute.	integer	Readonly
logical_router_id	Logical router id Logical router id	string	Required Readonly
med	Multi Exit Discriminator BGP Multi Exit Discriminator attribute.	integer	Readonly
neighbor_address	Neighbor IP address BGP neighbor peer IP address.	IPAddress	Required Readonly
neighbor_id	BGP neighbor id BGP neighbor id	string	Required Readonly
network	CIDR network address CIDR network address.	IPCIDRBlock	Required Readonly
next_hop	Next hop IP address Next hop IP address.	IPAddress	Readonly
source_address	BGP neighbor source address BGP neighbor source address.	IPAddress	Readonly
transport_node_id	Transport node id Transport node id	string	Required Readonly
weight	Weight BGP Weight attribute.	integer	Readonly

BgpNeighborRouteDetailsInCsvFormat (schema)

Name	Description	Type	Notes
file_name	File name File name set by HTTP server if API returns CSV result as a file.	string
results		array of BgpNeighborRouteDetailsCsvRecord

BgpNeighborRoutes (schema)

BGP neighbor route details

BGP neighbor learned/advertised route details.

Name	Description	Type	Notes
egde_node_routes	Route details per transport node Array of BGP neighbor route details per edge node.	array of RoutesPerTransportNode	Readonly
enforcement_point_path	Enforcement point policy path	string	Required Readonly
neighbor_path	BGP neighbor policy path	string	Required Readonly

BgpNeighborRoutesListResult (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Paged Collection of Bgp neighbor routes Paged Collection of Bgp neighbor routes.	array of BgpNeighborRoutes
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

BgpRouteFiltering (schema)

Enable address_families and route filtering in each direction

Name	Description	Type	Notes
address_family	Address family type Address family type. If not configured, this property automatically derived for IPv4 & IPv6 peer configuration.	string	Enum: IPV4, IPV6, L2VPN_EVPN
enabled	Enable address family Flag to enable address family.	boolean	Default: "True"
in_route_filters	Prefix-list or route map path for IN direction Specify path of prefix-list or route map to filter routes for IN direction.	array of string	Maximum items: 1
maximum_routes	Maximum number of routes for the address family Maximum number of routes for the address family.	int	Minimum: 1 Maximum: 1000000
out_route_filters	Prefix-list or route map path for OUT direction Specify path of prefix-list or route map to filter routes for OUT direction. When not specified, a built-in prefix-list named 'prefixlist-out-default' is automatically applied.	array of string	Maximum items: 1

BgpRoutesRequestParameters (schema)

BGP Routes request parameters

Name	Description	Type	Notes
count	Number of routes to retrieve Number of routes to return in response. Not used when routes are requested in CSV format.	int	Minimum: 1 Default: "1000"
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
enforcement_point_path	Enforcement point path String Path of the enforcement point. When not specified, routes from all enforcement-points are returned. This property is required for retrieving routes in CSV format.	string
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

BgpRoutingConfig (schema)

BGP routing config

Contains BGP routing configuration.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource (Abstract type: pass one of the following concrete types) ChildBgpNeighborConfig
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
ecmp	Flag to enable ECMP Flag to enable ECMP.	boolean
enabled	Flag to enable BGP configuration Flag to enable BGP configuration. Disabling will stop feature and BGP peering.	boolean
graceful_restart	Flag to enable graceful restart Flag to enable graceful restart. This field is deprecated, please use graceful_restart_config parameter for graceful restart configuration. If both parameters are set and consistent with each other (i.e. graceful_restart=false and graceful_restart_mode=HELPER_ONLY OR graceful_restart=true and graceful_restart_mode=GR_AND_HELPER) then this is allowed, but if inconsistent with each other then this is not allowed and validation error will be thrown.	boolean	Deprecated
graceful_restart_config	BGP Graceful Restart Configuration Configuration field to hold BGP Restart mode and timer.	BgpGracefulRestartConfig
id	Unique identifier of this resource	string	Sortable
inter_sr_ibgp	Enable inter SR IBGP configuration Flag to enable inter SR IBGP configuration. When not specified, inter SR IBGP is automatically enabled if Tier-0 is created in ACTIVE_ACTIVE ha_mode.	boolean
local_as_num	BGP AS number in ASPLAIN/ASDOT Format Specify BGP AS number for Tier-0 to advertize to BGP peers. AS number can be specified in ASPLAIN (e.g., "65546") or ASDOT (e.g., "1.10") format. Empty string disables BGP feature. It is required by normal tier0 but not required in vrf tier0.	string
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
multipath_relax	Flag to enable BGP multipath relax option Flag to enable BGP multipath relax option.	boolean
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 BgpRoutingConfig	string
route_aggregations	List of routes to be aggregated List of routes to be aggregated.	array of RouteAggregationEntry	Maximum items: 1000
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

BinaryPacketData (schema)

Name	Description	Type	Notes
frame_size	Requested total size of the (logical) packet in bytes If the requested frame_size is too small (given the payload and traceflow metadata requirement of 16 bytes), the traceflow request will fail with an appropriate message. The frame will be zero padded to the requested size.	integer	Minimum: 60 Maximum: 1000 Default: "128"
payload	RFC3548 compatible base64 encoded full payload Up to 1000 bytes of payload may be supplied (with a base64-encoded length of 1336 bytes.) Additional bytes of traceflow metadata will be appended to the payload. The payload must contain all headers (Ethernet, IP, etc). Note that VLAN is not supported in the logical space. Hence, payload must not contain 802.1Q headers.	string	Maximum length: 1336
resource_type	Must be set to the value BinaryPacketData	string	Required Enum: BinaryPacketData, FieldsPacketData Default: "FieldsPacketData"
routed	A flag, when set true, indicates that the traceflow packet is of L3 routing.	boolean
transport_type	transport type of the traceflow packet	string	Enum: BROADCAST, UNICAST, MULTICAST, UNKNOWN Default: "UNICAST"

BingdingMapStackStatusListRequestParameters (schema)

Request parameters for binding map mirror stack status

Request parameters for port/group/segment binding map mirror stack status.

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
enforcement_point_path	Binding map path enforcemnt point path to remote L3 mirror session String path for the enforcement point.	string
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

BridgeProfileConfig (schema)

Bridge Profile Configuration

configuration parameters for Bridge Profile

Name	Description	Type	Notes
bridge_profile_path	Policy path to L2 Bridge profile Same bridge profile can be configured on different segments. Each bridge profile on a segment must unique.	string	Required
uplink_teaming_policy_name	Uplink Teaming Policy Name The name of the switching uplink teaming policy for the bridge endpoint. This name corresponds to one fot he switching uplink teaming policy names listed in teh transport zone. When this property is not specified, the teaming policy is assigned by MP.	string
vlan_ids	VLAN IDs VLAN specification for bridge endpoint. Either VLAN ID or VLAN ranges can be specified. Not both.	array of string
vlan_transport_zone_path	Policy path to VLAN Transport Zone VLAN transport zone should belong to the enforcment-point as the transport zone specified in the segment.	string	Required

ByodPolicyServiceInstance (schema)

Represents instance of self wiring partner's service

Represents an instance of partner's service whose wiring will be done by partner itself.
As partner does all the wiring, we call it as Byod - Bring your own device.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
deployment_mode	Deployment Mode Deployment mode specifies how the partner appliance will be deployed i.e. in HA or standalone mode.	string	Enum: STAND_ALONE, ACTIVE_STANDBY Default: "ACTIVE_STANDBY"
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
partner_service_name	Name of Partner Service Unique name of Partner Service in the Marketplace	string	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 ByodPolicyServiceInstance	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
transport_type	Transport Type Transport to be used while deploying Service-VM.	string	Enum: L2_BRIDGE, L3_ROUTED Default: "L2_BRIDGE"
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

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
current_version_node_summary	Mapping of current versions of nodes and counts of nodes at the respective versions.	NodeSummaryList	Readonly
details	Details about the upgrade status	string	Readonly
node_count_at_target_version	Count of nodes at target component version Number of nodes of the type and at the component version	int	Readonly
percent_complete	Indicator of upgrade progress in percentage	number	Required Readonly
pre_upgrade_status	Pre-upgrade status of the component-type	UpgradeChecksExecutionStatus	Readonly
status	Upgrade status of component	string	Required Readonly Enum: SUCCESS, FAILED, IN_PROGRESS, NOT_STARTED, PAUSING, PAUSED
target_component_version	Target component version	string	Readonly

CentralConfigProperties (schema)

Central Config properties

Name	Description	Type	Notes
local_override	Override Central Config	boolean	Required

Certificate (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
details	List of X509Certificates.	array of X509Certificate	Readonly
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
pem_encoded	PEM encoded certificate data.	string	Required
resource_type	Must be set to the value Certificate	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
used_by	List of node IDs with services, that are using this certificate.	array of NodeIdServicesMap	Readonly

CertificateId (schema)

Name	Description	Type	Notes
certificate_id	Certificate ID	string	Required Readonly

ChildBfdProfile (schema)

Wrapper object for BfdProfile

Child wrapper for BfdProfile, used in hierarchical API.

Name	Description	Type	Notes
BfdProfile	Bfd Profile Contains the actual BfdProfile object.	BfdProfile	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildBfdProfile	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildBgpNeighborConfig (schema)

Wrapper object for BgpNeighborConfig

Child wrapper object for BgpNeighborConfig, used in hierarchical API.

Name	Description	Type	Notes
BgpNeighborConfig	BgpNeighborConfig Contains the actual BgpNeighborConfig object.	BgpNeighborConfig	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildBgpNeighborConfig	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildBgpRoutingConfig (schema)

Wrapper object for BgpRoutingConfig

Child wrapper object for BgpRoutingConfig, used in hierarchical API.

Name	Description	Type	Notes
BgpRoutingConfig	BgpRoutingConfig Contains the actual BgpRoutingConfig object.	BgpRoutingConfig	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildBgpRoutingConfig	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildByodPolicyServiceInstance (schema)

Wrapper object for ByodPolicyServiceInstance

Child wrapper object for ByodPolicyServiceInstance used in hierarchical API.

Name	Description	Type	Notes
ByodPolicyServiceInstance	ByodPolicyServiceInstance Contains actual ByodPolicyServiceInstance.	ByodPolicyServiceInstance	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildByodPolicyServiceInstance	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildCommunicationEntry (schema) (Deprecated)

Wrapper object for CommunicationEntry

Child wrapper object for CommunicationEntry, used in hierarchical API This type is deprecated. Use the type ChildRule instead.

Name	Description	Type	Notes
CommunicationEntry	CommunicationEntry Contains the actual CommunicationEntry object.	CommunicationEntry	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildCommunicationEntry	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildCommunicationMap (schema) (Deprecated)

Wrapper object for CommunicationMap

Child wrapper object for CommunicationMap, used in hierarchical API This type is deprecated. Use the type ChildSecurityPolicy instead.

Name	Description	Type	Notes
CommunicationMap	CommunicationMap Contains the actual CommunicationMap object.	CommunicationMap	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildCommunicationMap	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildCommunityList (schema)

Wrapper object for CommunityList

Child wrapper object for CommunityList, used in hierarchical API

Name	Description	Type	Notes
CommunityList	CommunityList Contains the actual CommunityList object	CommunityList	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildCommunityList	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildComputeClusterIdfwConfiguration (schema)

Wrapper object for ComputeClusterIdfwConfiguration

Name	Description	Type	Notes
ComputeClusterIdfwConfiguration	ComputeClusterIdfwConfiguration Contains the actual compute cluster idfw configuration object.	ComputeClusterIdfwConfiguration	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildComputeClusterIdfwConfiguration	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildConstraint (schema)

Wrapper object for Constraint

Child wrapper object for Constraint, used in hierarchical API

Name	Description	Type	Notes
Constraint	Constraint Contains the actual Constraint object	Constraint	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildConstraint	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildDeploymentZone (schema) (Deprecated)

Wrapper object for DeploymentZone

Child wrapper object for DeploymentZone, used in hierarchical API

Name	Description	Type	Notes
DeploymentZone	DeploymentZone Contains the actual DeploymentZone object	DeploymentZone	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildDeploymentZone	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildDfwFirewallConfiguration (schema) (Experimental)

Wrapper object for FirewallConfiguration

Name	Description	Type	Notes
DfwFirewallConfiguration	Dfw Firewall Configuration Contains the actual dfw firewall configuration list object.	DfwFirewallConfiguration	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildDfwFirewallConfiguration	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildDhcpRelayConfig (schema)

Wrapper object for DhcpRelayConfig

Child wrapper object for DhcpRelayConfig, used in hierarchical API

Name	Description	Type	Notes
DhcpRelayConfig	DhcpRelayConfig Contains the actual DhcpRelayConfig object	DhcpRelayConfig	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildDhcpRelayConfig	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildDhcpServerConfig (schema)

Wrapper object for DhcpServerConfig

Child wrapper object for DhcpServerConfig, used in hierarchical API

Name	Description	Type	Notes
DhcpServerConfig	DhcpServerConfig Contains the actual DhcpServerConfig object	DhcpServerConfig	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildDhcpServerConfig	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildDhcpStaticBindingConfig (schema)

Wrapper object for DhcpStaticBindingConfig

Child wrapper for DhcpStaticBindingConfig, used in hierarchical API.

Name	Description	Type	Notes
DhcpStaticBindingConfig	DhcpStaticBindingConfig Contains the actual DhcpStaticBindingConfig object.	DhcpStaticBindingConfig (Abstract type: pass one of the following concrete types) DhcpV4StaticBindingConfig DhcpV6StaticBindingConfig	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildDhcpStaticBindingConfig	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildDnsSecurityProfile (schema)

Wrapper object for DnsSecurityProfile

Child wrapper object for DnsSecurityProfile, used in hierarchical API

Name	Description	Type	Notes
DnsSecurityProfile	DnsSecurityProfile Contains the actual DnsSecurityProfile object	DnsSecurityProfile	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildDnsSecurityProfile	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildDnsSecurityProfileBindingMap (schema)

Wrapper object for DnsSecurityProfileBindingMap

Child wrapper obejct for DnsSecurityProfileBindingMap used in hierarchical API

Name	Description	Type	Notes
DnsSecurityProfileBindingMap	DnsSecurityProfileBindingMap Contains the actual DnsSecurityProfileBindingMap object	DnsSecurityProfileBindingMap	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildDnsSecurityProfileBindingMap	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildDomain (schema)

Wrapper object for Domain

Child wrapper object for domain, used in hierarchical API.

Name	Description	Type	Notes
Domain	Domain Contains the actual domain object.	Domain	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildDomain	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildDomainDeploymentMap (schema)

Wrapper object for DomainDeploymentMap

Child wrapper object for DomainDeploymentMap, used in hierarchical API.

Name	Description	Type	Notes
DomainDeploymentMap	DomainDeploymentMap Contains the actual DomainDeploymentMap object.	DomainDeploymentMap	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildDomainDeploymentMap	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildEndpointPolicy (schema)

Wrapper object for Endpoint Policy

Child wrapper object for EndpointPolicy used in hierarchical API.

Name	Description	Type	Notes
EndpointPolicy	EndpointPolicy Contains actual EndpointPolicy.	EndpointPolicy	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildEndpointPolicy	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildEndpointRule (schema)

Wrapper object for Endpoint Rule

Child wrapper object for EndpointRule used in hierarchical API.

Name	Description	Type	Notes
EndpointRule	EndpointRule Contains actual EndpointRule.	EndpointRule	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildEndpointRule	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildEnforcementPoint (schema)

Wrapper object for EnforcementPoint

Child wrapper object for EnforcementPoint, used in hierarchical API.

Name	Description	Type	Notes
EnforcementPoint	EnforcementPoint Contains the actual Enforcement point object.	EnforcementPoint	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildEnforcementPoint	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildEvpnConfig (schema)

Wrapper object for EvpnConfig

Child wrapper object for EvpnConfig, used in hierarchical API.

Name	Description	Type	Notes
EvpnConfig	EvpnConfig Contains the actual EvpnConfig object.	EvpnConfig	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildEvpnConfig	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildEvpnTunnelEndpointConfig (schema)

Wrapper object for EvpnTunnelEndpointConfig

Child wrapper object for EvpnTunnelEndpointConfig, used in hierarchical API.

Name	Description	Type	Notes
EvpnTunnelEndpointConfig	EvpnTunnelEndpointConfig Contains the actual EvpnTunnelEndpointConfig object.	EvpnTunnelEndpointConfig	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildEvpnTunnelEndpointConfig	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildFloodProtectionProfile (schema)

Wrapper object for FloodProtectionProfile

Child wrapper object for FloodProtectionProfile,
used in hierarchical API

Name	Description	Type	Notes
FloodProtectionProfile	FloodProtectionProfile Contains the actual FloodProtectionProfile object	FloodProtectionProfile (Abstract type: pass one of the following concrete types) DistributedFloodProtectionProfile GatewayFloodProtectionProfile	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildFloodProtectionProfile	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildFloodProtectionProfileBindingMap (schema)

Wrapper object for FloodProtectionProfileBindingMap

Child wrapper object for FloodProtectionProfileBindingMap,
used in hierarchical API

Name	Description	Type	Notes
FloodProtectionProfileBindingMap	FloodProtectionProfileBindingMap Contains the actual FloodProtectionProfileBindingMap object	FloodProtectionProfileBindingMap	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildFloodProtectionProfileBindingMap	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildForwardingPolicy (schema)

Wrapper object for children of type ForwardingPolicy

Child wrapper object for ForwardingPolicy used in Hierarchical API.

Name	Description	Type	Notes
ForwardingPolicy	ForwardingPolicy Contains actual ForwardingPolicy.	ForwardingPolicy	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildForwardingPolicy	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildForwardingRule (schema)

Wrapper object for ForwardingRule

Child wrapper object for ForwardingRule used in Hierarchical API.

Name	Description	Type	Notes
ForwardingRule	ForwardingRule Contains actual ForwardingRule.	ForwardingRule	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildForwardingRule	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildFqdnAnalysisConfig (schema)

Wrapper object for FqdnAnalysisConfig

Child wrapper object for FqdnAnalysisConfig, used in hierarchical API

Name	Description	Type	Notes
FqdnAnalysisConfig	FQDN Analysis Config Contains the actual FqdnAnalysisConfig object	FqdnAnalysisConfig	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildFqdnAnalysisConfig	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildGatewayPolicy (schema)

Wrapper object for GatewayPolicy

Child wrapper object for GatewayPolicy, used in hierarchical API

Name	Description	Type	Notes
GatewayPolicy	GatewayPolicy Contains the actual GatewayPolicy object	GatewayPolicy	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildGatewayPolicy	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildGatewayQosProfile (schema)

Wrapper object for GatewayQosProfile

Child wrapper for GatewayQosProfile, used in hierarchical API.

Name	Description	Type	Notes
QosProfile	GatewayQosProfile Contains the actual GatewayQosProfile object.	GatewayQosProfile	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildGatewayQosProfile	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildGeneralSecurityProfile (schema)

Wrapper object for GeneralSecurityProfile

Child wrapper object for GeneralSecurityProfile,
used in hierarchical API

Name	Description	Type	Notes
GeneralSecurityProfile	GeneralSecurityProfile Contains the actual GeneralSecurityProfile object	GeneralSecurityProfile (Abstract type: pass one of the following concrete types) GatewayGeneralSecurityProfile	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildGeneralSecurityProfile	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildGeneralSecurityProfileBindingMap (schema)

Wrapper object for GeneralSecurityProfileBindingMap

Child wrapper object for GeneralSecurityProfileBindingMap,
used in hierarchical API

Name	Description	Type	Notes
GeneralSecurityProfileBindingMap	GeneralSecurityProfileBindingMap Contains the actual GeneralSecurityProfileBindingMap object	GeneralSecurityProfileBindingMap	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildGeneralSecurityProfileBindingMap	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildGlobalConfig (schema)

Wrapper object for GlobalConfig

Child wrapper object for GlobalConfig, used in hierarchical API

Name	Description	Type	Notes
GlobalConfig	GlobalConfig Contains the actual GlobalConfig object.	GlobalConfig	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildGlobalConfig	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildGlobalIdsSignature (schema)

Wrapper object for GlobalIdsSignature

Child wrapper object for GlobalIdsSignature, used in hierarchical API

Name	Description	Type	Notes
GlobalIdsSignature	GlobalIdsSignature Contains the GlobalIdsSignature object	GlobalIdsSignature	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildGlobalIdsSignature	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildGlobalManager (schema)

Wrapper object for Global Manager

Child wrapper object for Global Manager, used in hierarchical API.

Name	Description	Type	Notes
GlobalManager	GlobalManager Contains the actual Global Manager object.	GlobalManager	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildGlobalManager	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildGroup (schema)

Wrapper object for Group

Child wrapper object for group, used in hierarchical API.

Name	Description	Type	Notes
Group	Group Contains the actual group objects.	Group	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildGroup	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildGroupDiscoveryProfileBindingMap (schema)

Wrapper object for GroupDiscoveryProfileBindingMap

Child wrapper obejct for GroupDiscoveryProfileBindingMap used in hierarchical API

Name	Description	Type	Notes
GroupDiscoveryProfileBindingMap	GroupDiscoveryProfileBindingMap Contains the actual GroupDiscoveryProfileBindingMap object	GroupDiscoveryProfileBindingMap	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildGroupDiscoveryProfileBindingMap	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildGroupMonitoringProfileBindingMap (schema)

Wrapper object for GroupMonitoringProfileBindingMap

Child wrapper object for GroupMonitoringProfileBindingMap, used in hierarchical API

Name	Description	Type	Notes
GroupMonitoringProfileBindingMap	GroupMonitoringProfileBindingMap Contains the actual GroupMonitoringProfileBindingMap object	GroupMonitoringProfileBindingMap	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildGroupMonitoringProfileBindingMap	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildIPDiscoveryProfile (schema)

Wrapper object for IPDiscoveryProfile

Child wrapper object for IPDiscoveryProfile, used in hierarchical API

Name	Description	Type	Notes
IPDiscoveryProfile	IPDiscoveryProfile Contains the actual IPDiscoveryProfile object	IPDiscoveryProfile	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildIPDiscoveryProfile	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildIPFIXDFWCollectorProfile (schema)

Wrapper object for IPFIXDFWCollectorProfile

Child wrapper object for IPFIXDFWCollectorProfile, used in hierarchical API

Name	Description	Type	Notes
IPFIXDFWCollectorProfile	IPFIXDFWCollectorProfile Contains the actual IPFIXDFWCollectorProfile object	IPFIXDFWCollectorProfile	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildIPFIXDFWCollectorProfile	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildIPFIXDFWProfile (schema)

Wrapper object for IPFIXDFWProfile

Child wrapper object for IPFIXDFWProfile, used in hierarchical API

Name	Description	Type	Notes
IPFIXDFWProfile	IPFIXDFWProfile Contains the actual IPFIXDFWProfile object	IPFIXDFWProfile	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildIPFIXDFWProfile	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildIPFIXL2CollectorProfile (schema)

Wrapper object for IPFIXL2CollectorProfile

Child wrapper object for IPFIXL2CollectorProfile, used in hierarchical API

Name	Description	Type	Notes
IPFIXL2CollectorProfile	IPFIXL2CollectorProfile Contains the actual IPFIXL2CollectorProfile object	IPFIXL2CollectorProfile	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildIPFIXL2CollectorProfile	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildIPFIXL2Profile (schema)

Wrapper object for IPFIXL2Profile

Child wrapper object for IPFIXL2Profile, used in hierarchical API

Name	Description	Type	Notes
IPFIXL2Profile	IPFIXL2Profile Contains the actual IPFIXL2Profile object	IPFIXL2Profile	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildIPFIXL2Profile	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildIPSecVpnDpdProfile (schema)

Wrapper object for IPSecVpnDpdProfile

Child wrapper object for IPSecVpnDpdProfile, used in hierarchical API.

Name	Description	Type	Notes
IPSecVpnDpdProfile	IPSecVpnDpdProfile Contains the actual IPSecVpnDpdProfile object.	IPSecVpnDpdProfile	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildIPSecVpnDpdProfile	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildIPSecVpnIkeProfile (schema)

Wrapper object for IPSecVpnIkeProfile

Child wrapper object for IPSecVpnIkeProfile, used in hierarchical API.

Name	Description	Type	Notes
IPSecVpnIkeProfile	IPSecVpnIkeProfile Contains the actual IPSecVpnIkeProfile object.	IPSecVpnIkeProfile	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildIPSecVpnIkeProfile	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildIPSecVpnLocalEndpoint (schema)

Wrapper object for IPSecVpnLocalEndpoint

Child wrapper object for IPSecVpnLocalEndpoint, used in hierarchical API.

Name	Description	Type	Notes
IPSecVpnLocalEndpoint	IPSecVpnLocalEndpoint Contains the actual IPSecVpnLocalEndpoint object.	IPSecVpnLocalEndpoint	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildIPSecVpnLocalEndpoint	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildIPSecVpnService (schema)

Wrapper object for IPSecVpnService

Child wrapper object for IPSecVpnService, used in hierarchical API.

Name	Description	Type	Notes
IPSecVpnService	IPSecVpnService Contains the actual IPSecVpnService object.	IPSecVpnService	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildIPSecVpnService	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildIPSecVpnSession (schema)

Wrapper object for IPSecVpnSession

Child wrapper object for IPSecVpnSession, used in hierarchical API.

Name	Description	Type	Notes
IPSecVpnSession	IPSecVpnSession Contains the actual IPSecVpnSession object.	IPSecVpnSession (Abstract type: pass one of the following concrete types) PolicyBasedIPSecVpnSession RouteBasedIPSecVpnSession	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildIPSecVpnSession	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildIPSecVpnTunnelProfile (schema)

Wrapper object for IPSecVpnTunnelProfile

Child wrapper object for IPSecVpnTunnelProfile, used in hierarchical API.

Name	Description	Type	Notes
IPSecVpnTunnelProfile	IPSecVpnTunnelProfile Contains the actual IPSecVpnTunnelProfile object	IPSecVpnTunnelProfile	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildIPSecVpnTunnelProfile	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildIdsClusterConfig (schema)

Wrapper object for IdsClusterConfig

Child wrapper object for IdsClusterConfig, used in hierarchical API

Name	Description	Type	Notes
IdsClusterConfig	IdsClusterConfig Contains the IdsClusterConfig object	IdsClusterConfig	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildIdsClusterConfig	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildIdsProfile (schema)

Wrapper object for IdsProfile

Child wrapper object for IdsProfile, used in hierarchical API

Name	Description	Type	Notes
IdsProfile	IdsProfile Contains the IdsProfile object	IdsProfile	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildIdsProfile	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildIdsRule (schema)

Wrapper object for IdsRule

Child wrapper object for IdsRule, used in hierarchical API

Name	Description	Type	Notes
IdsRule	IdsRule Contains the IdsRule object	IdsRule	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildIdsRule	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildIdsSecurityPolicy (schema)

Wrapper object for IdsSecurityPolicy

Child wrapper object for IdsSecurityPolicy, used in hierarchical API

Name	Description	Type	Notes
IdsSecurityPolicy	IdsSecurityPolicy Contains the IdsSecurityPolicy object	IdsSecurityPolicy	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildIdsSecurityPolicy	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildIdsSettings (schema)

Wrapper object for IdsSettings

Child wrapper object for IdsSettings, used in hierarchical API

Name	Description	Type	Notes
IdsSettings	IdsSettings Contains the IdsSettings object	IdsSettings	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildIdsSettings	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildIdsSignature (schema)

Wrapper object for IdsSignature

Child wrapper object for IdsSignature, used in hierarchical API

Name	Description	Type	Notes
IdsSignature	IdsSignature Contains the IdsSignature object	IdsSignature	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildIdsSignature	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildIdsSignatureStatus (schema)

Wrapper object for IdsSignatureStatus

Child wrapper object for IdsSignatureStatus, used in hierarchical API

Name	Description	Type	Notes
IdsSignatureStatus	IdsSignatureStatus Contains the IdsSignatureStatus object	IdsSignatureStatus	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildIdsSignatureStatus	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildIdsStandaloneHostConfig (schema)

Wrapper object for IdsStandaloneHostConfig

Child wrapper object for IdsStandaloneHostConfig, used in hierarchical API

Name	Description	Type	Notes
IdsStandaloneHostConfig	IdsStandaloneHostConfig Contains the IdsStandaloneHostConfig object	IdsStandaloneHostConfig	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildIdsStandaloneHostConfig	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildIpAddressAllocation (schema)

Wrapper object for IpAddressAllocation

Child wrapper object for IpAddressAllocation, used in hierarchical API

Name	Description	Type	Notes
IpAddressAllocation	IpAddressAllocation Contains the actual IpAddressAllocation object	IpAddressAllocation	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildIpAddressAllocation	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildIpAddressBlock (schema)

Wrapper object for IpAddressBlock

Child wrapper object for IpAddressBlock, used in hierarchical API

Name	Description	Type	Notes
IpAddressBlock	IpAddressBlock Contains the actual IpAddressBlock object	IpAddressBlock	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildIpAddressBlock	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildIpAddressPool (schema)

Wrapper object for IpAddressPool

Child wrapper object for IpAddressPool, used in hierarchical API

Name	Description	Type	Notes
IpAddressPool	IpAddressPool Contains the actual IpAddressPool object	IpAddressPool	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildIpAddressPool	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildIpAddressPoolSubnet (schema)

Wrapper object for IpAddressPoolSubnet

Child wrapper object for IpAddressPoolSubnet, used in hierarchical API

Name	Description	Type	Notes
IpAddressPoolSubnet	IpAddressPoolSubnet Contains the actual IpAddressPoolSubnet object	IpAddressPoolSubnet (Abstract type: pass one of the following concrete types) IpAddressPoolBlockSubnet IpAddressPoolStaticSubnet	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildIpAddressPoolSubnet	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildIpv6DadProfile (schema)

Wrapper object for Ipv6DadProfile

Child wrapper object for Ipv6DadProfile, used in hierarchical API

Name	Description	Type	Notes
Ipv6DadProfile	Ipv6DadProfile Contains the actual Ipv6DadProfile objects	Ipv6DadProfile	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildIpv6DadProfile	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildIpv6NdraProfile (schema)

Wrapper object for Ipv6NdraProfile

Child wrapper object for Ipv6NdraProfile, used in hierarchical API

Name	Description	Type	Notes
Ipv6NdraProfile	Ipv6NdraProfile Contains the actual Ipv6NdraProfile objects	Ipv6NdraProfile	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildIpv6NdraProfile	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildL2BridgeEndpointProfile (schema)

Wrapper object for L2BridgeEndpointProfile

Child wrapper object for L2BridgeEndpointProfile, used in hierarchical API

Name	Description	Type	Notes
L2BridgeEndpointProfile	L2BridgeEndpointProfile Contains the actual L2BridgeEndpointProfile object	L2BridgeEndpointProfile	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildL2BridgeEndpointProfile	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildL2VPNService (schema)

Wrapper object for L2VPNService

Child wrapper object for L2VPNService, used in hierarchical API.

Name	Description	Type	Notes
L2VPNService	L2VPNService Contains the actual L2VPNService object.	L2VPNService	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildL2VPNService	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildL2VPNSession (schema)

Wrapper object for L2VPNSession

Child wrapper object for L2VPNSession, used in hierarchical API.

Name	Description	Type	Notes
L2VPNSession	L2VPNSession Contains the actual L2VPNSession object.	L2VPNSession	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildL2VPNSession	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildL2Vpn (schema) (Deprecated)

Wrapper object for L2Vpn

Child wrapper object for L2Vpn, used in hierarchical API.

Name	Description	Type	Notes
L2Vpn	L2Vpn Contains the actual L2Vpn object.	L2Vpn	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildL2Vpn	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildL2VpnContext (schema) (Deprecated)

Wrapper object for L2VpnContext

Child wrapper object for L2VpnContext, used in hierarchical API.

Name	Description	Type	Notes
L2VpnContext	L2VpnContext Contains the actual L2VpnContext object.	L2VpnContext	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildL2VpnContext	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildL3Vpn (schema) (Deprecated)

Wrapper object for L3Vpn

Child wrapper object for L3Vpn, used in hierarchical API.

Name	Description	Type	Notes
L3Vpn	L3Vpn Contains the actual L3Vpn object.	L3Vpn	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildL3Vpn	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildL3VpnContext (schema) (Deprecated)

Wrapper object for L3VpnContext

Child wrapper object for L3VpnContext, used in hierarchical API.

Name	Description	Type	Notes
L3VpnContext	L3VpnContext Contains the actual L3VpnContext object.	L3VpnContext	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildL3VpnContext	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildLBAppProfile (schema)

Wrapper object for LBAppProfile

Child wrapper for LBAppProfile, used in hierarchical API.

Name	Description	Type	Notes
LBAppProfile	LBAppProfile Contains the actual LBAppProfile object.	LBAppProfile (Abstract type: pass one of the following concrete types) LBFastTcpProfile LBFastUdpProfile LBHttpProfile	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildLBAppProfile	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildLBClientSslProfile (schema)

Wrapper object for LBClientSslProfile

Child wrapper for LBClientSslProfile, used in hierarchical API.

Name	Description	Type	Notes
LBClientSslProfile	LBClientSslProfile Contains the actual LBClientSslProfile object.	LBClientSslProfile	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildLBClientSslProfile	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildLBMonitorProfile (schema)

Wrapper object for LBMonitorProfile

Child wrapper for LBMonitorProfile, used in hierarchical API.

Name	Description	Type	Notes
LBMonitorProfile	LBMonitorProfile Contains the actual LBMonitorProfile object.	LBMonitorProfile (Abstract type: pass one of the following concrete types) LBActiveMonitor LBHttpMonitorProfile LBHttpsMonitorProfile LBIcmpMonitorProfile LBPassiveMonitorProfile LBTcpMonitorProfile LBUdpMonitorProfile	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildLBMonitorProfile	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildLBPersistenceProfile (schema)

Wrapper object for LBPersistenceProfile

Child wrapper for LBPersistenceProfile, used in hierarchical API.

Name	Description	Type	Notes
LBPersistenceProfile	LBPersistenceProfile Contains the actual LBPersistenceProfile object.	LBPersistenceProfile (Abstract type: pass one of the following concrete types) LBCookiePersistenceProfile LBGenericPersistenceProfile LBSourceIpPersistenceProfile	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildLBPersistenceProfile	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildLBPool (schema)

Wrapper object for LBPool

Child wrapper for LBPool, used in hierarchical API.

Name	Description	Type	Notes
LBPool	LBPool Contains the actual LBPool object.	LBPool	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildLBPool	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildLBServerSslProfile (schema)

Wrapper object for LBServerSslProfile

Child wrapper for LBServerSslProfile, used in hierarchical API.

Name	Description	Type	Notes
LBServerSslProfile	LBServerSslProfile Contains the actual LBServerSslProfile object.	LBServerSslProfile	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildLBServerSslProfile	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildLBService (schema)

Wrapper object for LBService

Child wrapper for LBService, used in hierarchical API.

Name	Description	Type	Notes
LBService	LBService Contains the actual LBService object.	LBService	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildLBService	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildLBVirtualServer (schema)

Wrapper object for LBVirtualServer

Child wrapper for LBVirtualServer, used in hierarchical API.

Name	Description	Type	Notes
LBVirtualServer	LBVirtualServer Contains the actual LBVirtualServer object.	LBVirtualServer	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildLBVirtualServer	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildLiveTraceConfig (schema)

Wrapper object for LiveTraceConfig

Child wrapper for LiveTraceConfig for Hierarchical API

Name	Description	Type	Notes
LiveTraceConfig	LiveTraceConfig The actual LiveTraceConfig object.	LiveTraceConfig	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildLiveTraceConfig	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildLocaleServices (schema)

Wrapper object for LocaleServices

Child wrapper object for LocaleServices, used in hierarchical API

Name	Description	Type	Notes
LocaleServices	LocaleServices Contains the actual LocaleServices object	LocaleServices	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildLocaleServices	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildMacDiscoveryProfile (schema)

Wrapper object for MacDiscoveryProfile

Child wrapper object for MacDiscoveryProfile, used in hierarchical API

Name	Description	Type	Notes
MacDiscoveryProfile	MacDiscoveryProfile Contains the actual MacDiscoveryProfile object	MacDiscoveryProfile	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildMacDiscoveryProfile	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildMetadataProxyConfig (schema)

Wrapper object for MetadataProxyConfig

Name	Description	Type	Notes
MetadataProxyConfig	MetadataProxyConfig Contains the actual MetadataProxyConfig object.	MetadataProxyConfig	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildMetadataProxyConfig	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildPolicyConfigResource (schema)

Represents the desired state object as child resource

Represents an object on the desired state This is an abstract type. Concrete child types:
ChildBfdProfile
ChildBgpNeighborConfig
ChildBgpRoutingConfig
ChildByodPolicyServiceInstance
ChildCommunicationEntry
ChildCommunicationMap
ChildCommunityList
ChildComputeClusterIdfwConfiguration
ChildConstraint
ChildDeploymentZone
ChildDfwFirewallConfiguration
ChildDhcpRelayConfig
ChildDhcpServerConfig
ChildDhcpStaticBindingConfig
ChildDomain
ChildDomainDeploymentMap
ChildEndpointPolicy
ChildEndpointRule
ChildEnforcementPoint
ChildEvpnConfig
ChildEvpnTunnelEndpointConfig
ChildFloodProtectionProfile
ChildFloodProtectionProfileBindingMap
ChildForwardingPolicy
ChildForwardingRule
ChildFqdnAnalysisConfig
ChildGatewayPolicy
ChildGatewayQosProfile
ChildGeneralSecurityProfile
ChildGeneralSecurityProfileBindingMap
ChildGlobalIdsSignature
ChildGlobalManager
ChildGroup
ChildGroupMonitoringProfileBindingMap
ChildIPDiscoveryProfile
ChildIPFIXDFWCollectorProfile
ChildIPFIXDFWProfile
ChildIPFIXL2CollectorProfile
ChildIPFIXL2Profile
ChildIPSecVpnDpdProfile
ChildIPSecVpnIkeProfile
ChildIPSecVpnLocalEndpoint
ChildIPSecVpnService
ChildIPSecVpnSession
ChildIPSecVpnTunnelProfile
ChildIdsClusterConfig
ChildIdsProfile
ChildIdsRule
ChildIdsSecurityPolicy
ChildIdsSettings
ChildIdsSignature
ChildIdsSignatureStatus
ChildIdsStandaloneHostConfig
ChildIpAddressAllocation
ChildIpAddressBlock
ChildIpAddressPool
ChildIpAddressPoolSubnet
ChildL2VPNService
ChildL2VPNSession
ChildL2Vpn
ChildL2VpnContext
ChildL3Vpn
ChildL3VpnContext
ChildLBAppProfile
ChildLBClientSslProfile
ChildLBMonitorProfile
ChildLBPersistenceProfile
ChildLBPool
ChildLBServerSslProfile
ChildLBService
ChildLBVirtualServer
ChildLiveTraceConfig
ChildLocaleServices
ChildMacDiscoveryProfile
ChildMetadataProxyConfig
ChildPolicyContextProfile
ChildPolicyDnsForwarder
ChildPolicyDnsForwarderZone
ChildPolicyEdgeCluster
ChildPolicyEdgeNode
ChildPolicyExcludeList
ChildPolicyFirewallScheduler
ChildPolicyFirewallSessionTimerProfile
ChildPolicyLabel
ChildPolicyLbMonitorProfile
ChildPolicyLbPersistenceProfile
ChildPolicyLbPoolAccess
ChildPolicyLbRule
ChildPolicyLbVirtualServer
ChildPolicyNat
ChildPolicyNatRule
ChildPolicySIExcludeList
ChildPolicyServiceChain
ChildPolicyServiceInstance
ChildPolicyServiceProfile
ChildPolicyTransportZone
ChildPolicyUrlCategorizationConfig
ChildPortDiscoveryProfileBindingMap
ChildPortMirroringProfile
ChildPortMonitoringProfileBindingMap
ChildPortQoSProfileBindingMap
ChildPortSecurityProfileBindingMap
ChildPrefixList
ChildQoSProfile
ChildRedirectionPolicy
ChildRedirectionRule
ChildRule
ChildSIStatusConfiguration
ChildSecurityPolicy
ChildSegment
ChildSegmentDiscoveryProfileBindingMap
ChildSegmentMonitoringProfileBindingMap
ChildSegmentPort
ChildSegmentQoSProfileBindingMap
ChildSegmentSecurityProfile
ChildSegmentSecurityProfileBindingMap
ChildService
ChildServiceEntry
ChildServiceInstanceEndpoint
ChildServiceInterface
ChildServiceReference
ChildServiceSegment
ChildSessionTimerProfileBindingMap
ChildSite
ChildSpoofGuardProfile
ChildSslTrustObjectData
ChildStandaloneHostIdfwConfiguration
ChildStaticARPConfig
ChildStaticRouteBfdPeer
ChildStaticRoutes
ChildTier0
ChildTier0DeploymentMap
ChildTier0Interface
ChildTier0RouteMap
ChildTier1
ChildTier1DeploymentMap
ChildTier1Interface
ChildTlsCertificate
ChildTlsCrl
ChildTlsTrustData
ChildTraceflowConfig
ChildVirtualEndpoint
ChildVniPoolConfig

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildPolicyConfigResource	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildPolicyContextProfile (schema)

Wrapper object for PolicyContextProfile

Child wrapper object for PolicyContextProfile, used in hierarchical API

Name	Description	Type	Notes
PolicyContextProfile	PolicyContextProfile Contains the actual PolicyContextProfile objects	PolicyContextProfile	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildPolicyContextProfile	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildPolicyDnsForwarder (schema)

Wrapper object for PolicyDnsForwarder

Child wrapper object for PolicyDnsForwarder, used in hierarchical API

Name	Description	Type	Notes
PolicyDnsForwarder	PolicyDnsForwarder Contains the actual PolicyDnsForwarder object	PolicyDnsForwarder	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildPolicyDnsForwarder	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildPolicyDnsForwarderZone (schema)

Wrapper object for PolicyDnsForwarderZone

Child wrapper object for PolicyDnsForwarderZone, used in hierarchical API

Name	Description	Type	Notes
PolicyDnsForwarderZone	PolicyDnsForwarderZone Contains the actual PolicyDnsForwarderZone object	PolicyDnsForwarderZone	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildPolicyDnsForwarderZone	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildPolicyEdgeCluster (schema)

Wrapper object for PolicyEdgeCluster

Child wrapper object for PolicyEdgeCluster, used in hierarchical API.

Name	Description	Type	Notes
PolicyEdgeCluster	PolicyEdgeCluster Contains the actual PolicyEdgeCluster object.	PolicyEdgeCluster	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildPolicyEdgeCluster	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildPolicyEdgeNode (schema)

Wrapper object for PolicyEdgeNode

Child wrapper object for PolicyEdgeNode, used in hierarchical API.

Name	Description	Type	Notes
PolicyEdgeNode	PolicyEdgeNode Contains the actual PolicyEdgeNode object.	PolicyEdgeNode	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildPolicyEdgeNode	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildPolicyExcludeList (schema)

Wrapper object for PolicyExcludeList

Name	Description	Type	Notes
PolicyExcludeList	PolicyExcludeList Contains the actual policy exclude list object.	PolicyExcludeList	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildPolicyExcludeList	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildPolicyFirewallCPUMemThresholdsProfileBindingMap (schema)

Wrapper object for PolicyFirewallCPUMemThresholdsProfileBindingMap

Child wrapper object for PolicyFirewallCPUMemThresholdsProfileBindingMap,
used in hierarchical API.

Name	Description	Type	Notes
PolicyFirewallCPUMemThresholdsProfileBindingMap	PolicyFirewallCPUMemThresholdsProfileBindingMap Contains the actual PolicyFirewallCPUMemThresholdsProfileBindingMap object.	PolicyFirewallCPUMemThresholdsProfileBindingMap	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildPolicyFirewallCPUMemThresholdsProfileBindingMap	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildPolicyFirewallCpuMemThresholdsProfile (schema)

Wrapper object for PolicyFirewallCpuMemThresholdsProfile

Child wrapper object for PolicyFirewallCpuMemThresholdsProfile, used in
hierarchical API.

Name	Description	Type	Notes
PolicyFirewallCpuMemThresholdsProfile	PolicyFirewallCpuMemThresholdsProfile Contains the actual PolicyFirewallCpuMemThresholdsProfile object	PolicyFirewallCpuMemThresholdsProfile	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildPolicyFirewallCpuMemThresholdsProfile	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildPolicyFirewallFloodProtectionProfileBindingMap (schema)

Wrapper object for PolicyFirewallFloodProtectionProfileBindingMap

Child wrapper object for PolicyFirewallFloodProtectionProfileBindingMap,
used in hierarchical API

Name	Description	Type	Notes
PolicyFirewallFloodProtectionProfileBindingMap	PolicyFirewallFloodProtectionProfileBindingMap Contains the actual PolicyFirewallFloodProtectionProfileBindingMap object	PolicyFirewallFloodProtectionProfileBindingMap	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildPolicyFirewallFloodProtectionProfileBindingMap	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildPolicyFirewallScheduler (schema)

Wrapper object for PolicyFirewallScheduler

Child wrapper object for PolicyFirewallScheduler, used in hierarchical API

Name	Description	Type	Notes
PolicyFirewallScheduler	PolicyFirewallScheduler Contains the actual PolicyFirewallScheduler objects	PolicyFirewallScheduler	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildPolicyFirewallScheduler	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildPolicyFirewallSessionTimerProfile (schema)

Wrapper object for PolicyFirewallSessionTimerProfile

Child wrapper object for PolicyFirewallSessionTimerProfile,
used in hierarchical API

Name	Description	Type	Notes
PolicyFirewallSessionTimerProfile	PolicyFirewallSessionTimerProfile Contains the actual PolicyFirewallSessionTimerProfile object	PolicyFirewallSessionTimerProfile	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildPolicyFirewallSessionTimerProfile	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildPolicyFirewallSessionTimerProfileBindingMap (schema)

Wrapper object for PolicyFirewallSessionTimerProfileBindingMap

Child wrapper object for PolicyFirewallSessionTimerProfileBindingMap,
used in hierarchical API

Name	Description	Type	Notes
PolicyFirewallSessionTimerProfileBindingMap	PolicyFirewallSessionTimerProfileBindingMap Contains the actual PolicyFirewallSessionTimerProfileBindingMap object	PolicyFirewallSessionTimerProfileBindingMap	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildPolicyFirewallSessionTimerProfileBindingMap	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildPolicyIgmpProfile (schema)

Wrapper object for PolicyIgmpProfile

Child wrapper object for PolicyIgmpProfile used in hierarchical API.

Name	Description	Type	Notes
PolicyIgmpProfile	PolicyIgmpProfile Contains actual PolicyIgmpProfile.	PolicyIgmpProfile	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildPolicyIgmpProfile	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildPolicyLabel (schema)

Wrapper object for PolicyLabel

Child wrapper object for PolicyLabel, used in hierarchical API

Name	Description	Type	Notes
PolicyLabel	PolicyLabel Contains the actual PolicyLabel object	PolicyLabel	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildPolicyLabel	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildPolicyLbMonitorProfile (schema)

Wrapper object for PolicyLbMonitorProfile

Child wrapper for PolicyLbMonitorProfile, used in hierarchical API

Name	Description	Type	Notes
PolicyLbMonitorProfile	PolicyLbMonitorProfile Contains the actual PolicyLbMonitorProfile object	PolicyLbMonitorProfile (Abstract type: pass one of the following concrete types) HttpPolicyLbMonitorProfile HttpsPolicyLbMonitorProfile IcmpPolicyLbMonitorProfile TcpPolicyLbMonitorProfile UdpPolicyLbMonitorProfile	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildPolicyLbMonitorProfile	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildPolicyLbPersistenceProfile (schema)

Wrapper object for PolicyLbPersistenceProfile

Child wrapper for PolicyLbPersistenceProfile, used in hierarchical API

Name	Description	Type	Notes
PolicyLbPersistenceProfile	PolicyLbPersistenceProfile Contains the actual PolicyLbPersistenceProfile object	PolicyLbPersistenceProfile (Abstract type: pass one of the following concrete types) CustomPolicyLbPersistenceProfile L4PolicyLbPersistenceProfile L7PolicyLbPersistenceProfile	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildPolicyLbPersistenceProfile	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildPolicyLbPoolAccess (schema)

Wrapper object for PolicyLbPoolAccess

Child wrapper for PolicyLbPoolAccess, used in hierarchical API

Name	Description	Type	Notes
PolicyLbPoolAccess	PolicyLbPoolAccess Contains the actual PolicyLbPoolAccess object	PolicyLbPoolAccess	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildPolicyLbPoolAccess	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildPolicyLbRule (schema)

Wrapper object for PolicyLbRule

Child wrapper for PolicyLbRule, used in hierarchical API

Name	Description	Type	Notes
PolicyLbRule	PolicyLbRule Contains the actual PolicyLbRule object	PolicyLbRule	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildPolicyLbRule	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildPolicyLbVirtualServer (schema)

Wrapper object for PolicyLbVirtualServer

Child wrapper for PolicyLbVirtualServer, used in hierarchical API

Name	Description	Type	Notes
PolicyLbVirtualServer	PolicyLbVirtualServer Contains the actual PolicyLbVirtualServer object	PolicyLbVirtualServer (Abstract type: pass one of the following concrete types) CustomPolicyLbVirtualServer HttpPolicyLbVirtualServer HttpsPolicyLbVirtualServer TcpPolicyLbVirtualServer UdpPolicyLbVirtualServer	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildPolicyLbVirtualServer	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildPolicyMulticastConfig (schema)

Wrapper object for PolicyMulticastConfig

Child wrapper object for PolicyMulticastConfig used in hierarchical API.

Name	Description	Type	Notes
PolicyMulticastConfig	PolicyMulticastConfig Contains actual PolicyMulticastConfig.	PolicyMulticastConfig	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildPolicyMulticastConfig	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildPolicyNat (schema)

Wrapper object for PolicyNat

Child wrapper object for PolicyNat, used in hierarchical API

Name	Description	Type	Notes
PolicyNat	PolicyNat Contains the actual PolicyNAT object	PolicyNat	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildPolicyNat	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildPolicyNatRule (schema)

Wrapper object for PolicyNatRule

Child wrapper object for PolicyNatRule, used in hierarchical API

Name	Description	Type	Notes
PolicyNatRule	PolicyNatRule Contains the actual PolicyNatRule object	PolicyNatRule	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildPolicyNatRule	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildPolicyPimProfile (schema)

Wrapper object for PolicyPimProfile

Child wrapper object for PolicyPimProfile used in hierarchical API.

Name	Description	Type	Notes
PolicyPimProfile	PolicyPimProfile Contains actual PolicyPimProfile.	PolicyPimProfile	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildPolicyPimProfile	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildPolicySIExcludeList (schema)

Wrapper object for PolicySIExcludeList

Name	Description	Type	Notes
PolicySIExcludeList	PolicySIExcludeList Contains the actual policy exclude list object.	PolicySIExcludeList	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildPolicySIExcludeList	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildPolicyServiceChain (schema)

Wrapper object for PolicyServiceChain

Child wrapper object for PolicyServiceInstance used in hierarchical API.

Name	Description	Type	Notes
PolicyServiceChain	PolicyServiceChain Contains actual PolicyServiceChain.	PolicyServiceChain	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildPolicyServiceChain	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildPolicyServiceInstance (schema)

Wrapper object for PolicyServiceInstance

Child wrapper object for PolicyServiceInstance used in hierarchical API.

Name	Description	Type	Notes
PolicyServiceInstance	PolicyServiceInstance Contains actual PolicyServiceInstance.	PolicyServiceInstance	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildPolicyServiceInstance	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildPolicyServiceProfile (schema)

Wrapper object for PolicyServiceProfile

Child wrapper object for PolicyServiceProfile used in hierarchical API.

Name	Description	Type	Notes
PolicyServiceProfile	PolicyServiceProfile Contains actual PolicyServiceProfile.	PolicyServiceProfile	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildPolicyServiceProfile	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildPolicyTier1MulticastConfig (schema)

Wrapper object for PolicyTier1MulticastConfig

Child wrapper object for PolicyTier1MulticastConfig used in hierarchical API.

Name	Description	Type	Notes
PolicyTier1MulticastConfig	PolicyTier1MulticastConfig Contains actual PolicyTier1MulticastConfig.	PolicyTier1MulticastConfig	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildPolicyTier1MulticastConfig	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildPolicyTransportZone (schema)

Wrapper object for PolicyTransportZone

Child wrapper object for PolicyTransportZone, used in hierarchical API.

Name	Description	Type	Notes
PolicyTransportZone	PolicyTransportZone Contains the actual PolicyTransportZone object.	PolicyTransportZone	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildPolicyTransportZone	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildPolicyUrlCategorizationConfig (schema)

Wrapper object for PolicyUrlCategorizationConfig

Child wrapper object for PolicyUrlCategorizationConfig, used in hierarchical API

Name	Description	Type	Notes
PolicyUrlCategorizationConfig	URL Categorization Config Contains the actual PolicyUrlCategorizationConfig object	PolicyUrlCategorizationConfig	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildPolicyUrlCategorizationConfig	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildPortDiscoveryProfileBindingMap (schema)

Wrapper object for PortDiscoveryProfileBindingMap

Child wrapper object for PortDiscoveryProfileBindingMap, used in hierarchical API

Name	Description	Type	Notes
PortDiscoveryProfileBindingMap	PortDiscoveryProfileBindingMap Contains the actual PortDiscoveryProfileBindingMap object	PortDiscoveryProfileBindingMap	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildPortDiscoveryProfileBindingMap	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildPortMirroringProfile (schema)

Wrapper object for PortMirroringProfile

Child wrapper object for PortMirroringProfile, used in hierarchical API

Name	Description	Type	Notes
PortMirroringProfile	PortMirroringProfile Contains the actual PortMirroringProfile object	PortMirroringProfile	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildPortMirroringProfile	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildPortMonitoringProfileBindingMap (schema)

Wrapper object for PortMonitoringProfileBindingMap

Child wrapper object for PortMonitoringProfileBindingMap, used in hierarchical API

Name	Description	Type	Notes
PortMonitoringProfileBindingMap	PortMonitoringProfileBindingMap Contains the actual PortMonitoringProfileBindingMap object	PortMonitoringProfileBindingMap	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildPortMonitoringProfileBindingMap	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildPortQoSProfileBindingMap (schema)

Wrapper object for PortQoSProfileBindingMap

Child wrapper object for PortQoSProfileBindingMap, used in hierarchical API

Name	Description	Type	Notes
PortQoSProfileBindingMap	PortQoSProfileBindingMap Contains the actual PortQoSProfileBindingMap object	PortQoSProfileBindingMap	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildPortQoSProfileBindingMap	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildPortSecurityProfileBindingMap (schema)

Wrapper object for PortSecurityProfileBindingMap

Child wrapper object for PortSecurityProfileBindingMap, used in hierarchical API

Name	Description	Type	Notes
PortSecurityProfileBindingMap	PortSecurityProfileBindingMap Contains the actual PortSecurityProfileBindingMap object	PortSecurityProfileBindingMap	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildPortSecurityProfileBindingMap	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildPrefixList (schema)

Wrapper object for PrefixList

Child wrapper object for PrefixList, used in hierarchical API.

Name	Description	Type	Notes
PrefixList	PrefixList Contains the actual PrefixList object.	PrefixList	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildPrefixList	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildQoSProfile (schema)

Wrapper object for QoSProfile

Child wrapper object for QoSProfile, used in hierarchical API

Name	Description	Type	Notes
QoSProfile	QoSProfile Contains the actual QoSProfile object	QoSProfile	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildQoSProfile	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildReaction (schema)

Wrapper object for Reaction

Child wrapper object for Reaction used in hierarchical API.

Name	Description	Type	Notes
Reaction	Reaction Contains the actual Reaction object.	Reaction	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildReaction	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildRedirectionPolicy (schema)

Wrapper object for RedirectionPolicy

Child wrapper object for RedirectionPolicy used in Hierarchical API.

Name	Description	Type	Notes
RedirectionPolicy	RedirectionPolicy Contains actual RedirectionPolicy.	RedirectionPolicy	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildRedirectionPolicy	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildRedirectionRule (schema)

Wrapper object for RedirectionRule

Child wrapper object for ChildRedirectionRule used in Hierarchical API.

Name	Description	Type	Notes
RedirectionRule	RedirectionRule Contains actual RedirectionRule.	RedirectionRule	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildRedirectionRule	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildResourceReference (schema)

Represents the reference to ChildPolicyConfigResource

Represents a reference to ChildPolicyConfigResource in the hierarchical API. resource_type, id and target_type are mandatory fields.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildResourceReference	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
target_type	The target type of this reference	string	Required

ChildRule (schema)

Wrapper object for Rule

Child wrapper object for Rule, used in hierarchical API

Name	Description	Type	Notes
Rule	Rule Contains the actual Rule object	Rule	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildRule	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildSIStatusConfiguration (schema) (Experimental)

Wrapper object for PolicySIStatusConfiguration

Name	Description	Type	Notes
PolicySIStatusConfiguration	Contains the actual service insertion status configuration list object.	PolicySIStatusConfiguration	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildSIStatusConfiguration	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildSecurityPolicy (schema)

Wrapper object for SecurityPolicy

Child wrapper object for SecurityPolicy, used in hierarchical API

Name	Description	Type	Notes
SecurityPolicy	SecurityPolicy Contains the actual SecurityPolicy object	SecurityPolicy	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildSecurityPolicy	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildSegment (schema)

Wrapper object for Segment

Child wrapper object for Segment, used in hierarchical API.

Name	Description	Type	Notes
Segment	Segment Contains the actual Segment object.	Segment	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildSegment	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildSegmentDiscoveryProfileBindingMap (schema)

Wrapper object for SegmentDiscoveryProfileBindingMap

Child wrapper object for SegmentDiscoveryProfileBindingMap, used in hierarchical API

Name	Description	Type	Notes
SegmentDiscoveryProfileBindingMap	SegmentDiscoveryProfileBindingMap Contains the actual SegmentDiscoveryProfileBindingMap object	SegmentDiscoveryProfileBindingMap	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildSegmentDiscoveryProfileBindingMap	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildSegmentMonitoringProfileBindingMap (schema)

Wrapper object for SegmentMonitoringProfileBindingMap

Child wrapper object for SegmentMonitoringProfileBindingMap, used in hierarchical API

Name	Description	Type	Notes
SegmentMonitoringProfileBindingMap	SegmentMonitoringProfileBindingMap Contains the actual SegmentMonitoringProfileBindingMap object	SegmentMonitoringProfileBindingMap	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildSegmentMonitoringProfileBindingMap	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildSegmentPort (schema)

Wrapper object for SegmentPort

Child wrapper object for SegmentPort, used in hierarchical API

Name	Description	Type	Notes
SegmentPort	SegmentPort Contains the actual SegmentPort object	SegmentPort	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildSegmentPort	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildSegmentQoSProfileBindingMap (schema)

Wrapper object for SegmentQoSProfileBindingMap

Child wrapper object for SegmentQoSProfileBindingMap, used in hierarchical API

Name	Description	Type	Notes
SegmentQoSProfileBindingMap	SegmentQoSProfileBindingMap Contains the actual SegmentQoSProfileBindingMap object	SegmentQoSProfileBindingMap	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildSegmentQoSProfileBindingMap	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildSegmentSecurityProfile (schema)

Wrapper object for SegmentSecurityProfile

Child wrapper object for SegmentSecurityProfile, used in hierarchical API

Name	Description	Type	Notes
SegmentSecurityProfile	SegmentSecurityProfile Contains the actual SegmentSecurityProfile object	SegmentSecurityProfile	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildSegmentSecurityProfile	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildSegmentSecurityProfileBindingMap (schema)

Wrapper object for SegmentSecurityProfileBindingMap

Child wrapper object for SegmentSecurityProfileBindingMap, used in hierarchical API

Name	Description	Type	Notes
SegmentSecurityProfileBindingMap	SegmentSecurityProfileBindingMap Contains the actual SegmentSecurityProfileBindingMap object	SegmentSecurityProfileBindingMap	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildSegmentSecurityProfileBindingMap	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildService (schema)

Wrapper object for Service

Child wrapper object for Service, used in hierarchical API.

Name	Description	Type	Notes
Service	Service Contains the actual Service object.	Service	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildService	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildServiceEntry (schema)

Wrapper object for ServiceEntry

Child wrapper object for ServiceEntry, used in hierarchical API.

Name	Description	Type	Notes
Service	ServiceEntry This is a deprecated property, Please use 'ServiceEntry' instead.	ServiceEntry (Abstract type: pass one of the following concrete types) ALGTypeServiceEntry EtherTypeServiceEntry ICMPTypeServiceEntry IGMPTypeServiceEntry IPProtocolServiceEntry L4PortSetServiceEntry NestedServiceServiceEntry	Deprecated
ServiceEntry	ServiceEntry Contains the actual ServiceEntry object.	ServiceEntry (Abstract type: pass one of the following concrete types) ALGTypeServiceEntry EtherTypeServiceEntry ICMPTypeServiceEntry IGMPTypeServiceEntry IPProtocolServiceEntry L4PortSetServiceEntry NestedServiceServiceEntry	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildServiceEntry	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildServiceInstanceEndpoint (schema)

Wrapper object for ServiceInstanceEndpoint

Child wrapper object for ServiceInstanceEndpoint used in hierarchical API.

Name	Description	Type	Notes
ServiceInstanceEndpoint	ServiceInstanceEndpoint Contains actual ServiceInstanceEndpoint.	ServiceInstanceEndpoint	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildServiceInstanceEndpoint	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildServiceInterface (schema)

Wrapper object for ServiceInterface

Child wrapper object for ServiceInterface, used in hierarchical API.

Name	Description	Type	Notes
ServiceInterface	ServiceInterface Contains the actual ServiceInterface object.	ServiceInterface	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildServiceInterface	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildServiceReference (schema)

Wrapper object for ServiceReference

Child wrapper object for ServiceReference used in hierarchical API.

Name	Description	Type	Notes
ServiceReference	ServiceReference Contains actual ServiceReference.	ServiceReference	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildServiceReference	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildServiceSegment (schema)

Wrapper object for SerivceSegment

Child wrapper object for ServiceSegment, used in hierarchical API

Name	Description	Type	Notes
ServiceSegment	ServiceSegments Contains the actual ServiceSegment objects	ServiceSegment	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildServiceSegment	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildSessionTimerProfileBindingMap (schema)

Wrapper object for SessionTimerProfileBindingMap

Child wrapper object for SessionTimerProfileBindingMap,
used in hierarchical API

Name	Description	Type	Notes
SessionTimerProfileBindingMap	SessionTimerProfileBindingMap Contains the actual SessionTimerProfileBindingMap object	SessionTimerProfileBindingMap	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildSessionTimerProfileBindingMap	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildSite (schema)

Wrapper object for Site

Child wrapper object for Site, used in hierarchical API.

Name	Description	Type	Notes
Site	Site Contains the actual Site object.	Site	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildSite	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildSpoofGuardProfile (schema)

Wrapper object for SpoofGuardProfile

Child wrapper object for SpoofGuardProfile, used in hierarchical API

Name	Description	Type	Notes
SpoofGuardProfile	SpoofGuardProfile Contains the actual SpoofGuardProfile object	SpoofGuardProfile	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildSpoofGuardProfile	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildSslTrustObjectData (schema)

Wrapper object for SslTrustObjectData

Child wrapper for SslTrustObjectData, used in hierarchical API

Name	Description	Type	Notes
SslTrustObjectData	SslTrustObjectData Contains the actual SslTrustObjectData object	SslTrustObjectData	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildSslTrustObjectData	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildStandaloneHostIdfwConfiguration (schema)

Wrapper object for StandaloneHostIdfwConfiguration

Name	Description	Type	Notes
StandaloneHostIdfwConfiguration	StandaloneHostIdfwConfiguration Contains the actual standalone host idfw configuration object.	StandaloneHostIdfwConfiguration	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildStandaloneHostIdfwConfiguration	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildStaticARPConfig (schema)

Wrapper object for StaticARPConfig

Child wrapper object for StaticARPConfig, used in hierarchical API.

Name	Description	Type	Notes
StaticARPConfig	StaticARPConfig Contains the actual StaticARPConfig object.	StaticARPConfig	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildStaticARPConfig	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildStaticRouteBfdPeer (schema)

Wrapper object for StaticRouteBfdPeer

Child wrapper for StaticRouteBfdPeer, used in hierarchical API.

Name	Description	Type	Notes
BfdPeer	Static Route BFD Peer Contains the actual StaticRouteBfdPeer object.	StaticRouteBfdPeer	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildStaticRouteBfdPeer	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildStaticRoutes (schema)

Wrapper object for StaticRoutes

Child wrapper object for StaticRoutes, used in hierarchical API.

Name	Description	Type	Notes
StaticRoutes	StaticRoutes Contains the actual StaticRoutes object.	StaticRoutes	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildStaticRoutes	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildTier0 (schema)

Wrapper object for Tier-0

Child wrapper object for Tier-0, used in hierarchical API.

Name	Description	Type	Notes
Tier0	Tier-0 Contains the actual Tier-0 object.	Tier0	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildTier0	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildTier0DeploymentMap (schema)

Wrapper object for Tier0DeploymentMap

Child wrapper object for Tier0DeploymentMap, used in hierarchical API.

Name	Description	Type	Notes
Tier0DeploymentMap	Tier0DeploymentMap Contains the actual Tier0DeploymentMap object.	Tier0DeploymentMap	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildTier0DeploymentMap	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildTier0Interface (schema)

Wrapper object for Tier0Interface

Child wrapper object for Tier0Interface, used in hierarchical API.

Name	Description	Type	Notes
Tier0Interface	Tier0Interface Contains the actual Tier0Interface object.	Tier0Interface	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildTier0Interface	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildTier0RouteMap (schema)

Wrapper object for Tier0RouteMap

Child wrapper object for Tier0RouteMap, used in hierarchical API

Name	Description	Type	Notes
Tier0RouteMap	Tier0RouteMap Contains the actual Tier0RouteMap object	Tier0RouteMap	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildTier0RouteMap	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildTier1 (schema)

Wrapper object for Tier-1

Child wrapper object for Tier-1 , used in hierarchical API.

Name	Description	Type	Notes
Tier1	Tier-1 Contains the actual Tier-1 object.	Tier1	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildTier1	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildTier1DeploymentMap (schema)

Wrapper object for Tier1DeploymentMap

Child wrapper object for Tier1DeploymentMap, used in hierarchical API.

Name	Description	Type	Notes
Tier1DeploymentMap	Tier1DeploymentMap Contains the actual Tier1DeploymentMap object.	Tier1DeploymentMap	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildTier1DeploymentMap	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildTier1Interface (schema)

Wrapper object for Tier1Interface

Child wrapper object for Tier1Interface, used in hierarchical API.

Name	Description	Type	Notes
Tier1Interface	Tier1Interface Contains the actual Tier1Interface object.	Tier1Interface	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildTier1Interface	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildTlsCertificate (schema)

Wrapper object for TlsCertificate

Child wrapper for TlsCertificate, used in hierarchical API.

Name	Description	Type	Notes
TlsCertificate	TlsCertificate Contains the actual TlsCertificate object.	TlsCertificate	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildTlsCertificate	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildTlsCrl (schema)

Wrapper object for TlsCrl

Child wrapper for TlsCrl, used in hierarchical API.

Name	Description	Type	Notes
TlsCrl	TlsCrl Contains the actual TlsCrl object.	TlsCrl	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildTlsCrl	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildTlsTrustData (schema)

Wrapper object for TlsTrustData

Child wrapper for TlsTrustData, used in hierarchical API.

Name	Description	Type	Notes
TlsTrustData	TlsTrustData Contains the actual TlsTrustData object.	TlsTrustData	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildTlsTrustData	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildTraceflowConfig (schema)

Wrapper object for TraceflowConfig

Child wrapper for TraceflowConfig, used in hierarchical API

Name	Description	Type	Notes
TraceflowConfig	TraceflowConfig Contains the actual TraceflowConfig object.	TraceflowConfig	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildTraceflowConfig	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildTypesRequestParameter (schema)

Filter to populate child types of the policyConfigResource

Specified child resource types will be populated in the response body

Name	Description	Type	Notes
base_path	Base Path for retrieving hierarchical intent Base path of the resource for which user wants to retrieve the hierarchy. This should be the fully qualified path for the resource. - Sample examples - base_path=/infra/domains/default/groups/Group1 base_path=/infra/domains/default/security-policies/SecurityPolicy1/rules/Rule1	string
filter	Filter string as java regex Filter string, can contain multiple or single java regular expressions separated by ';'. - Sample query string to prevent loading services and deployment zones: filter=Type-^(?!.*?(?:Service|DeploymentZone)).*$ - Sample query string to load every policy object under Infra: filter=/	string
type_filter	Filter string to retrieve hierarchy. Advanced filter string in which user can directly specify the resourceTypes to be filtered. Can be used in conjunction with base_path. - Sample example of type_filter to load all groups - type_filter=Group - Sample example of multiple type_filter - type_filter=Group;SercurityPolicy;RedirectionPolicy - Sample eaxmple to load all groups in default domain using base_path in conjunction with type_filter - base_path=/infra/domains/default&type_filter=Group	string

ChildVirtualEndpoint (schema)

Wrapper object for VirtualEndpoint

Child wrapper object for VirtualEndpoint used in hierarchical API.

Name	Description	Type	Notes
VirtualEndpoint	VirtualEndpoint Contains reference to actual VirtualEndpoint.	VirtualEndpoint	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildVirtualEndpoint	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ChildVniPoolConfig (schema)

Wrapper object for VniPoolConfig

Child wrapper object for VniPoolConfig, used in hierarchical API.

Name	Description	Type	Notes
VniPoolConfig	VniPoolConfig Contains the actual VniPoolConfig object.	VniPoolConfig	Required
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
mark_for_override	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.	boolean	Default: "False"
resource_type	Must be set to the value ChildVniPoolConfig	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

CipherSuite (schema)

TLS cipher suite

Name	Description	Type	Notes
enabled	Enable status for this cipher suite	boolean	Required
name	Name of the TLS cipher suite	string	Required

ClasslessStaticRoute (schema)

DHCP classless static route option

DHCP classless static route option.

Name	Description	Type	Notes
network	Destination in CIDR Destination network in CIDR format.	IPElement	Required
next_hop	Router IP address of next hop of the route.	IPAddress	Required

ClientAuthType (schema)

client authentication mode

Client authentication could be REQUIRED or IGNORE.
REQUIRED means that client is required to present its
certificate to the server for authentication. To be accepted, client
certificate must be signed by one of the trusted Certificate
Authorities (CAs), also referred to as root CAs, whose self signed
certificates are specified in the same client SSL profile binding.
IGNORE means that client certificate would be ignored.

Name	Description	Type	Notes
ClientAuthType	client authentication mode Client authentication could be REQUIRED or IGNORE. REQUIRED means that client is required to present its certificate to the server for authentication. To be accepted, client certificate must be signed by one of the trusted Certificate Authorities (CAs), also referred to as root CAs, whose self signed certificates are specified in the same client SSL profile binding. IGNORE means that client certificate would be ignored.	string	Enum: REQUIRED, IGNORE

CloudNativeServiceInstance (schema)

Stores the information about cloud native service instance.

Name	Description	Type	Notes
_last_sync_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
external_id	External id of cloud native service instance in the system. Id of service instance fetched from public cloud.	string	Required Readonly
resource_type	Must be set to the value CloudNativeServiceInstance	string	Required
service_type	Type of cloud native service; possible values are ELB, RDS Type of cloud native service.	string	Required Readonly
source	Reference of the public cloud gateway Reference of the public cloud gateway that reported the service instance.	ResourceReference	Required Readonly
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ClusterBackupInfo (schema)

Cluster backup details

Name	Description	Type	Notes
ip_address	IP address or FQDN of the node from which the backup was taken	string	Required Readonly
node_id	ID of the node from which the backup was taken	string	Required Readonly
restore_type	Type of restore allowed	array of string	Readonly Enum: REGULAR_RESTORE, POLICY_ONLY_RESTORE Default: "[]"
timestamp	timestamp of the cluster backup file	EpochMsTimestamp	Required Readonly

ClusterBackupInfoListResult (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	List of timestamps of backed-up cluster files	array of ClusterBackupInfo	Required Readonly
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

ClusterCertificateId (schema)

Cluster Certificate ID

Name	Description	Type	Notes
certificate_id	Certificate ID	string	Required

ClusterConfiguration (schema)

Cluster configuration

The configuration of the NSX cluster. The cluster configuration consists of a list of cluster node attributes.

Name	Description	Type	Notes
cluster_id	UUID of the cluster	string	Readonly
config_version	Cluster configuration version	integer	Readonly
nodes	Nodes in the cluster configuration	array of ClusterNode	Readonly

ClusterNode (schema)

Cluster Node Properties

This type contains attributes of a cluster node that are relevant to the Cluster Boot Manager.

Name	Description	Type	Notes
entities	Entities on the node	array of ClusterNodeEntity	Required
node_uuid	UUID of the node	string	Required
status	Current clustering status of the node	string	Enum: JOINING, JOINED, REMOVING, REMOVED Default: "REMOVED"

ClusterNodeEntity (schema)

Cluster Node Entity Properties

NSX Cluster is made up of multiple cluster nodes. Each node can perform multiple functions, commonly referred to as roles. Cluster node entities are processes running in a cluster node that assist in the performance of a role. Cluster Boot Manager is a daemon that securely bootstraps and configures the entities. This type contains attributes of a cluster node entity that are relevant to the Cluster Boot Manager.

Name	Description	Type	Notes
certificate	Public certificate of the entity in PEM format	string	Required
entity_type	Type of the entity	string	Required Enum: MANAGER, CONTROLLER, POLICY, HTTPS, CLUSTER_BOOT_MANAGER, DATASTORE, GLOBAL_MANAGER, ASYNC_REPLICATOR, MONITORING, IDPS_REPORTING, CORFU_NONCONFIG
entity_uuid	UUID of the entity	string	Required
fqdn	Domain name the entity binds to	string
ip_address	IP address the entity binds to	string
port	Port the entity binds to	integer	Minimum: 0 Maximum: 65535
subnet_prefix_length	Subnet mask prefix length of the entity binds to	integer	Minimum: 0 Maximum: 32

ClusterRestoreStatus (schema)

Cluster restore status

Name	Description	Type	Notes
backup_timestamp	Timestamp when backup was initiated in epoch millisecond	EpochMsTimestamp	Required Readonly
endpoints	The list of allowed endpoints, based on the current state of the restore process	array of ResourceLink	Required Readonly
id	Unique id for backup request	string	Required Readonly
instructions	Instructions for users to reconcile Restore operations	array of InstructionInfo	Readonly
restore_end_time	Timestamp when restore was completed in epoch millisecond	EpochMsTimestamp	Readonly
restore_start_time	Timestamp when restore was started in epoch millisecond	EpochMsTimestamp	Readonly
status		GlobalRestoreStatus
step		RestoreStep
total_steps	Total number of steps in the entire restore process	integer	Required Readonly

ClusterRestoreStatusRequestParameters (schema)

Name	Description	Type	Notes
restore_component		string	Readonly Enum: LOCAL_MANAGER, GLOBAL_MANAGER Default: "LOCAL_MANAGER"

ClusterVirtualIpProperties (schema)

Cluster virtual IP properties

Name	Description	Type	Notes
ip_address	Virtual IP address, 0.0.0.0 if not configured	string	Required

ColumnItem (schema)

Grid Column

Represents a column of the Grid

Name	Description	Type	Notes
column_identifier	Identifier for this column Identifies the column and used for fetching content upon an user click or drilldown. If column identifier is not provided, the column's data will not participate in searches and drilldowns.	string
drilldown_id	Id of drilldown widget Id of drilldown widget, if any. Id should be a valid id of an existing widget.	string	Maximum length: 255
field	Column Field Field from which values of the column will be derived.	string	Required Maximum length: 1024
hidden	Hide the column If set to true, hides the column	boolean	Default: "False"
label	Column Label Label of the column.	Label	Required
navigation	Navigation to a specified UI page Hyperlink of the specified UI page that provides details. If drilldown_id is provided, then navigation cannot be used.	string	Maximum length: 1024
render_configuration	Render Configuration Render configuration to be applied, if any.	array of RenderConfiguration
sort_ascending	Represents order of sorting the values If true, the value of the column are sorted in ascending order. Otherwise, in descending order.	boolean	Default: "True"
sort_key	Key for sorting on this column Sorting on column is based on the sort_key. sort_key represents the field in the output data on which sort is requested.	string	Maximum length: 255
tooltip	Multi-line tooltip Multi-line text to be shown on tooltip while hovering over a cell in the grid.	array of Tooltip
type	Field data type Data type of the field.	string	Required Enum: String, Number, Date Maximum length: 255 Default: "String"

CommunicationEntry (schema) (Deprecated)

A communication entry specifies the security policy between the workload groups

A communication entry indicates the action to be performed for various types of traffic flowing between workload groups. This type is deprecated. Use the type Rule instead.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
action	Action The action to be applied to all the services.	string	Enum: ALLOW, DROP, REJECT
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Maximum items: 128
direction	Direction Define direction of traffic.	string	Enum: IN, OUT, IN_OUT Default: "IN_OUT"
disabled	Flag to disable the rule Flag to disable the rule. Default is enabled.	boolean	Default: "False"
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
logged	Enable logging flag Flag to enable packet logging. Default is disabled.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
notes	Text for additional notes on changes Text for additional notes on changes.	string
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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
scope	The list of policy paths where the communication entry is applied Edge/LR/T0/T1/LRP/CGW/MGW/etc. Note that a given rule can be applied on multiple LRs/LRPs.	array of string	Maximum items: 128
sequence_number	Sequence number of the this CommunicationEntry This field is used to resolve conflicts between multiple CommunicationEntries under CommunicationMap for a Domain If no sequence number is specified in the payload, a value of 0 is assigned by default. If there are multiple communication entries with the same sequence number then their order is not deterministic. If a specific order of communication entry is desired, then one has to specify unique sequence numbers or use the POST request on the communication entry entity with a query parameter action=revise to let the framework assign a sequence number	int
services	Names of services 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	Maximum items: 128
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	Maximum items: 128
tag	Tag applied on the communication entry User level field which will be printed in CLI and packet logs.	string	Maximum length: 32
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

CommunicationMap (schema) (Deprecated)

Contains ordered list of CommunicationEntries

Ordered list of CommunicationEntries. This object is created by default
along with the Domain.
This type is deprecated. Use the type SecurityPolicy instead.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
category	A way to classify a communication map, if needed. - Distributed Firewall - Policy framework for Distributed Firewall provides four pre-defined categories for classifying a communication map. They are "Emergency", "Infrastructure", "Environment" and "Application". Amongst the layer 3 communication maps,there is a pre-determined order in which the policy framework manages the priority of these communication maps. Emergency category has the highest priority followed by Infrastructure, Environment and then Application rules. Administrator can choose to categorize a communication map into the above categories or can choose to leave it empty. If empty it will have the least precedence w.r.t the above four layer 3 categories.	string
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 one can fire a POST request on the communication map entity with a query parameter 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. If no precedence is specified in the payload, a value of 0 is assigned by default. If there are multiple communication maps with the same precedence then their order is not deterministic. If a specific order of communication map is desired, then one has to specify a unique precedence or use the POST request on the communication map entity with a query parameter action=revise to let the framework assign a precedence	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: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

CommunityList (schema)

Community list for BGP routing configuration

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
communities	List of BGP community entries List of BGP community entries. Both standard and large communities are supported. Standard community format: aa:nn where aa and nn must be within the range [1 - 65536]. Large BGP Community format: aa:bb:nn where aa (Global Administrator), bb (Local Data Part 1) and nn (Local Data Part 2) must be within the range [1 - 4294967295]. In additon to numbered communites (e.g. 3356:2040), predefined communities (NO_EXPORT, NO_ADVERTISE, NO_EXPORT_SUBCONFED) are supported.	array of string	Required Minimum items: 1
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 CommunityList	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

CommunityListListResult (schema)

Paged collection of CommunityLists

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	CommunityList results	array of CommunityList	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

CommunityMatchCriteria (schema)

Match criteria based on a community list

Name	Description	Type	Notes
criteria	Match criteria based on community list path or a regular expression Match criteria specified as a community list path or a regular expression.	string	Required
match_operator	Match operator for community list entries Match operator for community list entries. Not valid when a regular expression is specified for criteria.	string	Enum: MATCH_ANY, MATCH_ALL, MATCH_EXACT, MATCH_COMMUNITY_REGEX, MATCH_LARGE_COMMUNITY_REGEX

CompatibilityDetail (schema)

Feature Compatibility Details

Feature compatibility status details indicating specific site configuration
incompatibility with global manager configuration.

Name	Description	Type	Notes
attributes	Additional Attributes	array of OnboardingAttribute	Readonly Maximum items: 20
status_code	Status Code Unique integer number indicating configuration incompatibility.	integer	Required Readonly
status_message	Status Message A brief explaination of status code.	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 on which the action is performed or on which the results are filtered	string
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

ComponentUpgradeChecksInfo (schema)

Meta-data of pre/post-upgrade checks for a component

Meta-data of pre/post-upgrade checks for a component

Name	Description	Type	Notes
component_type	Component type Component type of the pre/post-upgrade checks	string	Required
post_upgrade_checks_info	Collection of post-upgrade checks	array of UpgradeCheckInfo
pre_upgrade_checks_info	Collection of pre-upgrade checks	array of UpgradeCheckInfo

ComponentUpgradeChecksInfoListResult (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Collection of info of pre/post-upgrade checks for components	array of ComponentUpgradeChecksInfo	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

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
current_version_node_summary	Mapping of current versions of nodes and counts of nodes at the respective versions.	NodeSummaryList	Readonly
details	Details about the upgrade status	string	Readonly
node_count_at_target_version	Count of nodes at target component version Number of nodes of the type and at the component version	int	Readonly
percent_complete	Indicator of upgrade progress in percentage	number	Required Readonly
pre_upgrade_status	Pre-upgrade status of the component-type	UpgradeChecksExecutionStatus	Readonly
status	Upgrade status of component	string	Required Readonly Enum: SUCCESS, FAILED, IN_PROGRESS, NOT_STARTED, PAUSING, PAUSED
target_component_version	Target component version	string	Readonly

ComputeClusterIdfwConfiguration (schema)

Compute cluster idfw configuration

Idfw configuration for enable/disable idfw on cluster level.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
cluster_idfw_enabled	Idfw enabled flag If set to true, idfw is enabled for this cluster	boolean	Required
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
member	PolicyResourceReference Contains actual policy resource reference object	PolicyResourceReference	Required
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 ComputeClusterIdfwConfiguration	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

ComputeCollection (schema)

Name	Description	Type	Notes
_last_sync_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cm_local_id	Local Id of the compute collection in the Compute Manager	string	Required Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
external_id	External ID of the ComputeCollection in the source Compute manager, e.g. mo-ref in VC	string	Required Readonly
origin_id	Id of the compute manager from where this Compute Collection was discovered	string	Required Readonly
origin_properties	Key-Value map of additional specific properties of compute collection in the Compute Manager	array of KeyValuePair	Readonly
origin_type	ComputeCollection type like VC_Cluster. Here the Compute Manager type prefix would help in differentiating similar named Compute Collection types from different Compute Managers	string	Required Readonly
owner_id	Id of the owner of compute collection in the Compute Manager	string	Readonly
resource_type	Must be set to the value ComputeCollection	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Condition (schema)

Represents the leaf level condition

Represents the leaf level condition. Evaluation of the condition expression
will be case insensitive.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
key	Key	string	Required Enum: Tag, Name, OSName, ComputerName
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
member_type	Group member type	string	Required Enum: IPSet, VirtualMachine, LogicalPort, LogicalSwitch, Segment, SegmentPort
operator	operator	string	Required Enum: EQUALS, CONTAINS, STARTSWITH, ENDSWITH, NOTEQUALS
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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, ExternalIDExpression, PathExpression, IdentityGroupExpression
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly
value	Value	string	Required Minimum length: 1

ConditionalValueConstraintExpression (schema)

Represents the leaf level conditional value constraint.

Represents the leaf level expression to restrict the target attribute value
based on the set of existing values. Generally, used in combination with
RelatedAttributeConditionalExpression to constraint the values related to
another attribute on the same resource. This object is always used in
conjunction with some exression.
Example -
{
"condition" : {
"operator":"INCLUDES",
"rhs_value": ["/infra/domains/mgw/groups/VCENTER", "/infra/domains/mgw/groups/SRM", "/infra/domains/mgw/groups/NSX"],
"value_constraint": {
"resource_type": "ValueConstraintExpression",
"operator":"EXCLUDES",
"values":["/infra/domains/mgw/groups/VCENTER", "/infra/domains/mgw/groups/SRM", "/infra/domains/mgw/groups/NSX"]
}
}

Name	Description	Type	Notes
operator	Set operation to constraint values.	string	Required Enum: INCLUDES, EXCLUDES, EQUALS
rhs_value	Array of values to perform operation. List of values.	array of string	Required
value_constraint	Value Constraint Values to apply the conditional constraint on target.	ValueConstraintExpression	Required

ConfigOnboardingConflictRequest (schema)

Config onboarding conflict Request

Config onboarding request to verify conflicts in onboarding configuration
on global manager for a site.

Name	Description	Type	Notes
prefix	Prefix string User provided prefix string to resolve conflicting site entities.	string	Readonly
site_id	Site Id Site Id.	string	Readonly
suffix	Suffix string User provided suffix string to resolve conflicting site entities.	string

ConfigOnboardingConflictStatus (schema)

Config onboarding conflict status

Represents config onboarding conflict status on Global Manager.

Name	Description	Type	Notes
details		OnboardingFeatureInfo	Readonly
site_id	Site Id Site identifier of the site being onboarded.	string	Required Readonly
status		OnboardingConflictStatus	Required Readonly

ConfigOnboardingError (schema)

Config Onboarding Error

Represents error details in case of system fail to onboard site
configuration on global manager.

Name	Description	Type	Notes
error_code	Error Code Error code for errors found during onboarding process.	integer	Readonly
error_message	Error message Failure reason during onboarding process.	string	Readonly

ConfigOnboardingInProgressStatus (schema)

Config Onboarding in-progress status

Represents config onboarding status including processing phase compared to
of total number of phases to complete config onboarding.

Name	Description	Type	Notes
current_step	Current Onboarding Step Represent intermidiate phase when onboarding or rollback is in-progress on global manager.	integer	Readonly
feature		OnboardingFeatureInfo	Readonly
stage		OnboardingStage	Readonly
total_steps	Total number of Onboarding Steps Total number of phases involved in onboarding workflow.	integer	Readonly

ConfigOnboardingRequest (schema)

Config onboarding Request

Config onboarding request to initiate onboarding workflow on global manager
for a site.

Name	Description	Type	Notes
prefix	Prefix string User provided prefix string to resolve conflicting site entities.	string	Readonly
site_backup_reference	Site Backup Reference Site backup image details to hint user to restore site before starting onboarding process.	string	Required Readonly
site_id	Site Id Site Id.	string	Readonly
suffix	Suffix string User provided suffix string to resolve conflicting site entities.	string

ConfigOnboardingStatus (schema)

Config on-boarding status

Represents config onboarding status on Global Manager.

Name	Description	Type	Notes
details		ConfigOnboardingStatusDetails	Readonly
site_id	Site Id Site identifier of the site being onboarded.	string	Required Readonly
status		OnboardingStatus	Required Readonly
supported_features	List of supported features List of supported features on global manager.	array of OnboardingFeatureInfo	Readonly
timestamp	Status Timestamp Onboarding status as of current timestamp.	EpochMsTimestamp	Required
unsupported_features	List of unsupported features List of unsupported features on global manager.	array of OnboardingFeatureInfo	Readonly

ConfigOnboardingStatusDetails (schema)

Config on-boarding status details

Represents config on-boarding progress phase details per feature
information with progress metric like completed entity count against total
number of entities.

Name	Description	Type	Notes
error_messages		array of ConfigOnboardingError	Readonly
import_progress		ConfigOnboardingInProgressStatus	Readonly
revert_progress		ConfigOnboardingInProgressStatus	Readonly
site_backup_reference	Site Backup Reference Site backup image details to hint user to restore site before starting onboarding process.	string	Readonly

ConfigState (schema)

Config State

Configuration State.

Name	Description	Type	Notes
ConfigState	Config State Configuration State.	string	Enum: SUCCESS, IN_PROGRESS, ERROR, UNKNOWN, UNINITIALIZED

ConfigurationState (schema)

Describes status of configuration of an entity

Name	Description	Type	Notes
details	Array of configuration state of various sub systems	array of ConfigurationStateElement	Readonly
failure_code	Error code	integer	Readonly
failure_message	Error message in case of failure	string	Readonly
state	Overall state of desired configuration Gives details of state of desired configuration. Additional enums with more details on progress/success/error states are sent for edge node. The success states are NODE_READY and TRANSPORT_NODE_READY, pending states are {VM_DEPLOYMENT_QUEUED, VM_DEPLOYMENT_IN_PROGRESS, REGISTRATION_PENDING} and other values indicate failures. "in_sync" state indicates that the desired configuration has been received by the host to which it applies, but is not yet in effect. When the configuration is actually in effect, the state will change to "success". Please note, failed state is deprecated.	string	Required Readonly Enum: pending, in_progress, success, failed, partial_success, orphaned, unknown, error, in_sync, NOT_AVAILABLE, VM_DEPLOYMENT_QUEUED, VM_DEPLOYMENT_IN_PROGRESS, VM_DEPLOYMENT_FAILED, VM_POWER_ON_IN_PROGRESS, VM_POWER_ON_FAILED, REGISTRATION_PENDING, NODE_NOT_READY, NODE_READY, VM_POWER_OFF_IN_PROGRESS, VM_POWER_OFF_FAILED, VM_UNDEPLOY_IN_PROGRESS, VM_UNDEPLOY_FAILED, VM_UNDEPLOY_SUCCESSFUL, EDGE_CONFIG_ERROR, VM_DEPLOYMENT_RESTARTED, REGISTRATION_FAILED, TRANSPORT_NODE_SYNC_PENDING, TRANSPORT_NODE_CONFIGURATION_MISSING, EDGE_HARDWARE_NOT_SUPPORTED, MULTIPLE_OVERLAY_TZS_NOT_SUPPORTED, TN_OVERLAY_TZ_IN_USE_BY_EDGE_CLUSTER, TZ_ENDPOINTS_NOT_SPECIFIED, NO_PNIC_PREPARED_IN_EDGE, APPLIANCE_INTERNAL_ERROR, VTEP_DHCP_NOT_SUPPORTED, UNSUPPORTED_HOST_SWITCH_PROFILE, UPLINK_HOST_SWITCH_PROFILE_NOT_SPECIFIED, HOSTSWITCH_PROFILE_NOT_FOUND, LLDP_SEND_ENABLED_NOT_SUPPORTED, UNSUPPORTED_NAMED_TEAMING_POLICY, LBSRCID_NOT_SUPPORTED_FOR_EDGE_VM, LACP_NOT_SUPPORTED_FOR_EDGE_VM, STANDBY_UPLINKS_NOT_SUPPORTED_FOR_EDGE_VM, MULTIPLE_ACTIVE_UPLINKS_NOT_SUPPORTED_FOR_EDGE, UNSUPPORTED_LACP_LB_ALGO_FOR_NODE, EDGE_NODE_VERSION_NOT_SUPPORTED, NO_PNIC_SPECIFIED_IN_TN, INVALID_PNIC_DEVICE_NAME, TRANSPORT_NODE_READY, VM_NETWORK_EDIT_PENDING, UNSUPPORTED_DEFAULT_TEAMING_POLICY, MPA_DISCONNECTED, VM_RENAME_PENDING, VM_CONFIG_EDIT_PENDING, VM_NETWORK_EDIT_FAILED, VM_RENAME_FAILED, VM_CONFIG_EDIT_FAILED, VM_CONFIG_DISCREPANCY, VM_NODE_REFRESH_FAILED, VM_PLACEMENT_REFRESH_FAILED, REGISTRATION_TIMEDOUT, REPLACE_FAILED, UPLINK_FROM_TEAMING_POLICY_NOT_MAPPED, LOGICAL_SWITCH_NAMED_TEAMING_HAS_NO_PNIC_BACKING, DELETE_VM_IN_REDEPLOY_FAILED, DEPLOY_VM_IN_REDEPLOY_FAILED, INSUFFICIENT_RESOURCES_IN_EDGE_NODE_FOR_SERVICE

ConfigurationStateElement (schema)

Describes status of configuration of an entity

Name	Description	Type	Notes
failure_code	Error code	integer	Readonly
failure_message	Error message in case of failure	string	Readonly
state	State of configuration on this sub system	string	Required Readonly Enum: in_progress, success, failed, partial_success, in_sync, VM_DEPLOYMENT_FAILED, VM_POWER_ON_FAILED, VM_POWER_OFF_FAILED, VM_UNDEPLOY_FAILED, REPLACE_FAILED, UPLINK_FROM_TEAMING_POLICY_NOT_MAPPED, LOGICAL_SWITCH_NAMED_TEAMING_HAS_NO_PNIC_BACKING, DELETE_VM_IN_REDEPLOY_FAILED, DEPLOY_VM_IN_REDEPLOY_FAILED, INSUFFICIENT_RESOURCES_IN_EDGE_NODE_FOR_SERVICE, EDGE_CONFIG_ERROR, REGISTRATION_FAILED, TRANSPORT_NODE_CONFIGURATION_MISSING, EDGE_HARDWARE_NOT_SUPPORTED, MULTIPLE_OVERLAY_TZS_NOT_SUPPORTED, TN_OVERLAY_TZ_IN_USE_BY_EDGE_CLUSTER, TZ_ENDPOINTS_NOT_SPECIFIED, NO_PNIC_PREPARED_IN_EDGE, APPLIANCE_INTERNAL_ERROR, VTEP_DHCP_NOT_SUPPORTED, UNSUPPORTED_HOST_SWITCH_PROFILE, UPLINK_HOST_SWITCH_PROFILE_NOT_SPECIFIED, HOSTSWITCH_PROFILE_NOT_FOUND, LLDP_SEND_ENABLED_NOT_SUPPORTED, UNSUPPORTED_NAMED_TEAMING_POLICY, LBSRCID_NOT_SUPPORTED_FOR_EDGE_VM, LACP_NOT_SUPPORTED_FOR_EDGE_VM, STANDBY_UPLINKS_NOT_SUPPORTED_FOR_EDGE_VM, MULTIPLE_ACTIVE_UPLINKS_NOT_SUPPORTED_FOR_EDGE, UNSUPPORTED_LACP_LB_ALGO_FOR_NODE, EDGE_NODE_VERSION_NOT_SUPPORTED, NO_PNIC_SPECIFIED_IN_TN, INVALID_PNIC_DEVICE_NAME, UNSUPPORTED_DEFAULT_TEAMING_POLICY, MPA_DISCONNECTED, VM_NETWORK_EDIT_PENDING, VM_RENAME_PENDING, VM_CONFIG_EDIT_PENDING, VM_NETWORK_EDIT_FAILED, VM_RENAME_FAILED, VM_CONFIG_EDIT_FAILED, VM_CONFIG_DISCREPANCY, VM_NODE_REFRESH_FAILED, VM_PLACEMENT_REFRESH_FAILED, NOT_AVAILABLE, REGISTRATION_TIMEDOUT, pending, orphaned, unknown, error
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_name	Name of backing resource on sub system	string	Readonly
sub_system_type	Type of backing resource on sub system	string	Readonly

ConflictingEntityListResponse (schema)

List of Features with conflict information

Name	Description	Type	Notes
example	Conflict example Conflict example	OnboardingFeatureInfo	Readonly
feature_compability_data		array of FeatureCompatibilityInfo	Readonly Maximum items: 100
feature_descendants		array of FeatureConflictInfo	Readonly
feature_summary		FeatureSummary	Readonly
infra_descendants		array of FeatureConflictInfo	Readonly

ConjunctionOperator (schema)

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.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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, ExternalIDExpression, PathExpression, IdentityGroupExpression
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

ConnectivityAdvancedConfig (schema)

Advanced configuration for Policy connectivity

Name	Description	Type	Notes
connectivity	Connectivity configuration Connectivity configuration to manually connect (ON) or disconnect (OFF) a Tier1 segment from corresponding Tier1 gateway. Only valid for Tier1 Segments. This property is ignored for L2 VPN extended segments when subnets property is not specified.	string	Enum: ON, OFF Default: "ON"

ConsolidatedAPIListRequestParameters (schema)

Consolidated effective IP addresses API list request parameters

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
included_fields	Comma separated list of fields that should be included in query result	string
ip_filter	An IPAddress or subnet for filtering the results. This filter can be used to verify an ip membership in the effective results	IPElement
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
site_id	UUID of the site from which the effective IP addresses are to be fetched	string
sort_ascending		boolean
sort_by	Field by which records are sorted	string

ConsolidatedEffectiveIPAddressMemberListResult (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Paged Collection of site wise consolidated effective ip addresses for the given NSGroup	array of EffectiveIPInfo	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

ConsolidatedEffectiveIPListRequestParameters (schema)

Consolidated API Realization list request params

List request params for the pass through type api that get data from the
Enforcement point. Enforcement point is mandatory for this request.

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
enforcement_point_path	String Path of the enforcement point The path of the enforcement point on which the API needs to be executed. Forward slashes must be escaped using %2F.	string
included_fields	Comma separated list of fields that should be included in query result	string
ip_filter	An IPAddress or subnet for filtering the results. This filter can be used to verify an ip membership in the effective results	IPElement
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
site_id	UUID of the site from which the effective IP addresses are to be fetched	string
sort_ascending		boolean
sort_by	Field by which records are sorted	string

ConsolidatedRealizedStatus (schema)

Consolidated Realized Status for an Intent Object

Consolidated Realized Status of an intent object across enforcement points.

Name	Description	Type	Notes
consolidated_status	Consolidated Realized Status Consolidated Realized Status across enforcement points.	ConsolidatedStatus	Readonly
consolidated_status_per_enforcement_point	List of Consolidated Realized Status per Enforcement Point List of Consolidated Realized Status per enforcement point.	array of ConsolidatedStatusPerEnforcementPoint	Readonly
intent_path	String Path of the intent object Intent path of object, forward slashes must be escaped using %2F.	string	Required Readonly
intent_version	Intent version for the status Represent highest intent version across all realized objects	string	Readonly
publish_status	Aggregated Realization state of this object	string	Required Enum: UNAVAILABLE, UNREALIZED, REALIZED, ERROR

ConsolidatedStatus (schema)

Consolidated Status

Consolidated Status of an intent object. Status Consolidation of an intent happens at
multiple levels:
- Per Enforcement Point: calculation of the consolidated status is performed using all
realized entities that the intent objet maps to on a specific enforcement point.
- Across Enforcement Points: calculation of the consolidated status is performend
aggregating the consolidated status from each enforcement point.

Name	Description	Type	Notes
consolidated_status	Consolidated Realized Status Consolidated Realized Status of an intent object.	ConfigState	Readonly

ConsolidatedStatusNsxT (schema)

NSX-T Consolidated Status

Detailed Realized Status of an intent object on an NSX-T type of enforcement point.

Name	Description	Type	Notes
alarm	Alarm Information Details Alarm information details.	PolicyRuntimeAlarm	Readonly
consolidated_status	Consolidated Realized Status Consolidated Realized Status of an Intent object per enforcement point.	ConsolidatedStatus	Readonly
enforced_status	Enforced Realized Status Detailed Realized Status inherent to an NSX-T Enforcement Point.	EnforcedStatusDetailsNsxT	Readonly
enforcement_point_id	Enforcement Point Id Enforcement Point Id.	string	Readonly
enforcement_point_path	Enforcement point Path Policy Path referencing the enforcement point where the info is fetched.	string	Readonly
resource_type	Must be set to the value ConsolidatedStatusNsxT	string	Required
site_path	Site Path The site where this enforcement point resides.	string	Readonly

ConsolidatedStatusPerEnforcementPoint (schema)

Consolidated Realized Status Per Enforcement Point

Consolidated Realized Status Per Enforcement Point.

Name	Description	Type	Notes
alarm	Alarm Information Details Alarm information details.	PolicyRuntimeAlarm	Readonly
consolidated_status	Consolidated Realized Status Consolidated Realized Status of an Intent object per enforcement point.	ConsolidatedStatus	Readonly
enforcement_point_id	Enforcement Point Id Enforcement Point Id.	string	Readonly
enforcement_point_path	Enforcement point Path Policy Path referencing the enforcement point where the info is fetched.	string	Readonly
resource_type	Must be set to the value ConsolidatedStatusPerEnforcementPoint	string	Required
site_path	Site Path The site where this enforcement point resides.	string	Readonly

ConstantFieldValue (schema)

Constant Field Value

Constant Field Value.

Name	Description	Type	Notes
constant	Constant Value Constant Value that the field must be set to.	object
resource_type	Must be set to the value ConstantFieldValue	string	Required Enum: ConstantFieldValue

Constraint (schema)

Constraint definition.

Constraint object to constraint any attribute on a resource based on
specified expression.
Example- Restrict the allowed services in Edge Communication Entry to list of
services, if the destinationGroups contain vCenter.
{
"target":{
"target_resource_type":"CommunicationEntry",
"attribute":"services",
"path_prefix":"/infra/domains/vmc-domain/edge-communication-maps/default/communication-entries"
}
"constraint_expression":{
"related_attribute":{
"attribute":"destinationGroups"
}
"condition":{
"operator":"INCLUDES",
"rhs_value":{"vCenter"}
"value_constraint":{
"operator":"ALLOW",
"values":{"/ref/services/HTTPS", "/ref/services/HTTOP", ...}
}
}
}
}

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
constraint_expression	Expression to constrain the target attribute value.	ConstraintExpression (Abstract type: pass one of the following concrete types) EntityInstanceCountConstraintExpression FieldSanityConstraintExpression RelatedAttributeConditionalExpression ValueConstraintExpression	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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
message	User friendly message to be shown to users upon violation.	string
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 Constraint	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
target	Target resource attribute details.	ConstraintTarget	Required
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

ConstraintExpression (schema)

Base class for constraint expression

All the types of the expression extend from this abstract class.
This is present for extensibility.
This is an abstract type. Concrete child types:
EntityInstanceCountConstraintExpression
FieldSanityConstraintExpression
RelatedAttributeConditionalExpression
ValueConstraintExpression

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
resource_type	Must be set to the value ConstraintExpression	string	Required Enum: ValueConstraintExpression, RelatedAttributeConditionalExpression, EntityInstanceCountConstraintExpression, FieldSanityConstraintExpression
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ConstraintListResult (schema)

Paged Collection of Constraints

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Constraint list results	array of Constraint	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

ConstraintTarget (schema)

Resource attribute on which constraint should be applied.

Resource attribute on which constraint should be applied.
Example - sourceGroups attribute of Edge CommunicationEntry to be
restricted, is given as:
{
"target_resource_type":"CommunicationEntry",
"attribute":"sourceGroups",
"path_prefix":"/infra/domains/vmc-domain/edge-communication-maps/default/communication-entries"
}

Name	Description	Type	Notes
attribute	Attribute name of the target entity.	string
path_prefix	Path prefix of the entity to apply constraint. This is required to further disambiguiate if multiple policy entities share the same resource type. Example - Edge FW and DFW use the same resource type CommunicationMap, CommunicationEntry, Group, etc.	string
target_resource_type	Resource type of the target entity.	string	Required

ContainerApplication (schema)

Container application within a project

Container application within a project.

Name	Description	Type	Notes
_last_sync_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
container_cluster_id	Identifier of the container cluster Identifier of the container cluster this container application belongs to.	string	Readonly
container_project_id	Identifier of the project Identifier of the project which this container application belongs to.	string
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
external_id	External identifier of the container application Identifier of the container application on container cluster e.g. PCF app id, k8s service id.	string	Required
network_errors	Network errors List of network errors related to container application.	array of NetworkError
network_status	Network status of container application Network status of container application.	string	Enum: HEALTHY, UNHEALTHY
origin_properties	Origin properties Array of additional specific properties of container application in key-value format.	array of KeyValuePair
resource_type	Must be set to the value ContainerApplication	string	Required
status	Status of the container application Status of the container application.	string	Enum: UNKNOWN, HEALTHY, UP, DOWN, DEGRADED
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ContainerApplicationInstance (schema)

Container Application Instance

Container application instance within a project.

Name	Description	Type	Notes
_last_sync_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cluster_node_id	Cluster node id Cluster node id where application instance is running.	string
container_application_ids	Identifiers of the container application List of identifiers of the container application.	array of string
container_cluster_id	Identifier of the container cluster Identifier of the container cluster this application instance belongs to.	string	Readonly
container_project_id	Identifier of the project Identifier of the container project which this container application instance belongs to.	string
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
external_id	External identifier of the container application instance Identifier of the container application instance on container cluster.	string	Required
network_errors	Network errors List of network errors related to container application instance.	array of NetworkError
network_status	Network status of container application instance Network status of container application instance.	string	Enum: HEALTHY, UNHEALTHY
origin_properties	Origin properties Array of additional specific properties of container application instance in key-value format.	array of KeyValuePair
resource_type	Must be set to the value ContainerApplicationInstance	string	Required
status	Status of the container application instance Status of the container application instance.	string	Enum: UNKNOWN, HEALTHY, UP, DOWN, DEGRADED
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ContainerCluster (schema)

Container cluster

Details of container cluster.

Name	Description	Type	Notes
_last_sync_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cluster_type	Type of the container cluster Type of the container cluster. In case of creating container cluster first time, it is expected to pass the valid cluster-type. In case of update, if there is no change in cluster-type, then this field can be omitted in the request.	string	Enum: PAS, PKS, Kubernetes, Openshift, WCP, WCP_Guest, Other
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
external_id	External identifier of the container cluster External identifier of the container cluster.	string
infrastructure	Details of infrastructure for the container cluster Details of underlying infrastructure that hosts the container cluster. In case of creating container cluster first time, it is expected to pass the valid infrastructure. In case of update, if there is no change in cluster-type, then this field can be omitted in the request.	ContainerInfrastructureInfo
network_errors	Network errors List of network errors related to container cluster.	array of NetworkError
network_status	Network status of container cluster Network status of container cluster.	string	Enum: HEALTHY, UNHEALTHY
origin_properties	Origin properties Array of additional specific properties of container cluster in key-value format.	array of KeyValuePair
resource_type	Must be set to the value ContainerCluster	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ContainerClusterNode (schema)

Container cluster node

Details of container cluster node i.e. container host.

Name	Description	Type	Notes
_last_sync_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
container_cluster_id	External identifier of the container cluster External identifier of the container cluster.	string
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
external_id	External identifier of the container cluster node External identifier of the container cluster node in K8S/PAS.	string	Required
ip_addresses	IP Addresses of Node List of IP addresses of container cluster node.	array of IPAddress
network_errors	Network errors List of network errors related to container cluster node.	array of NetworkError
network_status	Network status of container cluster node Network status of container cluster node.	string	Enum: HEALTHY, UNHEALTHY
origin_properties	Origin properties Array of additional specific properties of container cluster node in key-value format.	array of KeyValuePair
resource_type	Must be set to the value ContainerClusterNode	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ContainerConfiguration (schema)

Container that holds widgets

Represents a container to group widgets that belong to a common category or have a common purpose.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
datasources	Array of Datasource Instances with their relative urls The 'datasources' represent the sources from which data will be fetched. Currently, only NSX-API is supported as a 'default' datasource. An example of specifying 'default' datasource along with the urls to fetch data from is given at 'example_request' section of 'CreateWidgetConfiguration' API.	array of Datasource	Minimum items: 0
default_filter_value	Default filter value to be passed to datasources Default filter values to be passed to datasources. This will be used when the report is requested without filter values.	array of DefaultFilterValue
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Widget Title Title of the widget. If display_name is omitted, the widget will be shown without a title.	string	Maximum length: 255
drilldown_id	Id of drilldown widget Id of drilldown widget, if any. Id should be a valid id of an existing widget. A widget is considered as drilldown widget when it is associated with any other widget and provides more detailed information about any data item from the parent widget.	string	Maximum length: 255
feature_set	Features required to view the widget Features required to view the widget.	FeatureSet
filter	Id of filter widget for subscription Id of filter widget for subscription, if any. Id should be a valid id of an existing filter widget. Filter widget should be from the same view. Datasource URLs should have placeholder values equal to filter alias to accept the filter value on filter change.	string
filter_value_required	Flag to indicate if filter value is necessary Flag to indicate that widget will continue to work without filter value. If this flag is set to false then default_filter_value is manadatory.	boolean	Default: "True"
footer		Footer
header		Header
icons	Icons Icons to be applied at dashboard for widgets and UI elements.	array of Icon
id	Unique identifier of this resource	string	Sortable
is_drilldown	Set as a drilldown widget Set to true if this widget should be used as a drilldown.	boolean	Default: "False"
labels	Labels Labels for the container.	array of Label	Minimum items: 0
layout	Layout of widgets inside container Layout of widgets can be either vertical or horizontal. If layout is not specified a default horizontal layout is applied.	Layout
legend	Legend for the widget Legend to be displayed. If legend is not needed, do not include it.	Legend
navigation	Navigation to a specified UI page Hyperlink of the specified UI page that provides details.	string	Maximum length: 1024
resource_type	Must be set to the value ContainerConfiguration	string	Required Readonly Enum: LabelValueConfiguration, DonutConfiguration, MultiWidgetConfiguration, ContainerConfiguration, StatsConfiguration, GridConfiguration, GraphConfiguration, CustomWidgetConfiguration, DropdownFilterWidgetConfiguration Maximum length: 255
shared	Visiblity of widgets to other users Please use the property 'shared' of View instead of this. The widgets of a shared view are visible to other users.	boolean	Deprecated
span	Horizontal span Represents the horizontal span of the widget / container.	int	Minimum: 1 Maximum: 12
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
weight	Weightage or placement of the widget or container Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details.	int	Deprecated
widgets	Widgets held by the container If not specified, creates an empty container.	array of WidgetItem	Minimum items: 0

ContainerInfrastructureInfo (schema)

Details of container infrastructure

Details of infrastructure hosting the container cluster
e.g. vSphere, AWS, VMC etc..

Name	Description	Type	Notes
infra_type	Type of the infrastructure Type of the infrastructure.	string	Required Enum: vSphere, AWS, Azure, VMC, KVM, Baremetal

ContainerIngressPolicy (schema)

Container Ingress Policy

Details of Container Ingress Policy.

Name	Description	Type	Notes
_last_sync_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
container_application_ids	Identifiers of the container application List of identifiers of the container application , on which ingress policy is applied. e.g. IDs of all services on which the ingress is applied in kubernetes.	array of string
container_cluster_id	Identifier of the container cluster Identifier of the container cluster this ingress policy belongs to.	string
container_project_id	Identifier of the project Identifier of the project which this container ingress belongs to.	string
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
external_id	External identifier of the container ingress policy Identifier of the container ingress policy.	string	Required
network_errors	Network errors List of network errors related to container ingress.	array of NetworkError
network_status	Network status of container ingress Network status of container ingress.	string	Enum: HEALTHY, UNHEALTHY
origin_properties	Origin properties Array of additional specific properties of container ingress in key-value format.	array of KeyValuePair
resource_type	Must be set to the value ContainerIngressPolicy	string	Required
spec	Container ingress policy specification Container ingress policy specification.	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ContainerNetworkPolicy (schema)

Container Network Policy

Network policy applied to container.

Name	Description	Type	Notes
_last_sync_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
container_cluster_id	Identifier of the container cluster Identifier of the container cluster this network policy belongs to.	string
container_project_id	Identifier of the project Identifier of the project which this network policy belongs to.	string
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
external_id	External identifier of the container network policy Identifier of the container network policy.	string	Required
network_errors	Network errors List of network errors related to container network policy.	array of NetworkError
network_status	Network status of container network policy Network status of container network policy.	string	Enum: HEALTHY, UNHEALTHY
origin_properties	Origin properties Array of additional specific properties of container network policy in key-value format.	array of KeyValuePair
policy_type	Type Type e.g. Network Policy, ASG.	string	Enum: NETWORK_POLICY, ASG
resource_type	Must be set to the value ContainerNetworkPolicy	string	Required
spec	Container network policy specification Container network policy specification.	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ContainerProject (schema)

Container project within a container cluster

Details of org/namespace within a container cluster.

Name	Description	Type	Notes
_last_sync_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
container_cluster_id	Identifier of the container cluster Identifier of the container cluster to which this project/namespace belongs.	string
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
external_id	External identifier of the container project External identifier of the container project.	string	Required
network_errors	Network errors List of network errors related to container project.	array of NetworkError
network_status	Network status of container project Network status of container project.	string	Enum: HEALTHY, UNHEALTHY
origin_properties	Origin properties Array of additional specific properties of container project in key-value format.	array of KeyValuePair
resource_type	Must be set to the value ContainerProject	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ContentFilterValue (schema)

Support bundle content filter allowed values

Name	Description	Type	Notes
ContentFilterValue	Support bundle content filter allowed values	string	Enum: ALL, DEFAULT

ContextProfileAttributesMetadata (schema)

Key value structure for holding metadata of context profile attributes

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

ContinueRequestParameters (schema)

Name	Description	Type	Notes
component_type	Component to upgrade. Hints NSX to upgrade a specific component.	string
skip	Skip to upgrade of next component.	boolean	Default: "False"

CookiePersistenceModeType (schema)

cookie persistence mode

If the persistence cookie is found in the incoming request, value of the
cookie is used to identify the server that this request should be sent to.
If the cookie is not found, then the server selection algorithm is used to
select a new server to handle that request.
Three different modes of cookie persistence are supported: insert, prefix
and rewrite.
In cookie insert mode, a cookie is inserted by load balancer in the HTTP
response going from server to client.
In cookie prefix and rewrite modes, server controls the cookie and load
balancer only manipulates the value of the cookie. In prefix mode, server's
cookie value is prepended with the server IP and port and then sent to the
client. In rewrite mode, entire server's cookie value is replaced with the
server IP and port in the response before sending it to the client.

Name	Description	Type	Notes
CookiePersistenceModeType	cookie persistence mode If the persistence cookie is found in the incoming request, value of the cookie is used to identify the server that this request should be sent to. If the cookie is not found, then the server selection algorithm is used to select a new server to handle that request. Three different modes of cookie persistence are supported: insert, prefix and rewrite. In cookie insert mode, a cookie is inserted by load balancer in the HTTP response going from server to client. In cookie prefix and rewrite modes, server controls the cookie and load balancer only manipulates the value of the cookie. In prefix mode, server's cookie value is prepended with the server IP and port and then sent to the client. In rewrite mode, entire server's cookie value is replaced with the server IP and port in the response before sending it to the client.	string	Enum: INSERT, PREFIX, REWRITE

CopyFromRemoteFileProperties (schema)

Name	Description	Type	Notes
port	Server port	integer	Minimum: 1 Maximum: 65535
protocol	Protocol to use to copy file	Protocol (Abstract type: pass one of the following concrete types) HttpProtocol HttpsProtocol ScpProtocol SftpProtocol	Required
server	Remote server hostname or IP address	string	Required Pattern: "^[^/:]+$"
uri	URI of file to copy	string	Required

CopyRemoteFileProperties (schema)

Name	Description	Type	Notes
port	Server port	integer	Minimum: 1 Maximum: 65535
server	Remote server hostname or IP address	string	Required Pattern: "^[^/:]+$"
uri	URI of file to copy	string	Required

CopyToRemoteFileProperties (schema)

Name	Description	Type	Notes
port	Server port	integer	Minimum: 1 Maximum: 65535
protocol	Protocol to use to copy file Only scp and sftp may be used.	Protocol (Abstract type: pass one of the following concrete types) HttpProtocol HttpsProtocol ScpProtocol SftpProtocol	Required
server	Remote server hostname or IP address	string	Required Pattern: "^[^/:]+$"
uri	URI of file to copy	string	Required

CountActionArgument (schema)

Name	Description	Type	Notes
count_type	Type of count	string	Required Readonly Enum: ALL, INTERFACE_ONLY

CountActionConfig (schema)

Name	Description	Type	Notes
action_argument	The count action argument	CountActionArgument	Required

CpuUsage (schema)

CPU usage of DPDK and non-DPDK cores

Name	Description	Type	Notes
avg_cpu_core_usage_dpdk	Indicates the average usage of all DPDK cores in percentage.	number	Readonly
avg_cpu_core_usage_non_dpdk	Average usage of all non-DPDK cores Indicates the average usage of all non-DPDK cores in percentage.	number	Readonly
highest_cpu_core_usage_dpdk	Highest CPU utilization value among DPDK cores Indicates the highest CPU utilization value among DPDK cores in percentage.	number	Readonly
highest_cpu_core_usage_non_dpdk	Highest CPU utilization value among non-DPDK cores Indicates the highest cpu utilization value among non_dpdk cores in percentage.	number	Readonly

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

Criterion (schema)

Event Criterion

Event Criterion is the logical evaluations by which the event may
be deemed fulfilled. All the evaluations must be met in order for
the criterion to be met (implicit AND).

Name	Description	Type	Notes
evaluations	Criterion Evaluations Criterion Evaluations.	array of Evaluation (Abstract type: pass one of the following concrete types) SourceFieldEvaluation	Required Minimum items: 1

CsvListResult (schema)

Base type for CSV result.

Name	Description	Type	Notes
file_name	File name File name set by HTTP server if API returns CSV result as a file.	string

CsvRecord (schema)

Base type for CSV records.

Name	Description	Type	Notes
CsvRecord	Base type for CSV records.	object

CurrentBackupOperationStatus (schema)

Current backup operation status

Name	Description	Type	Notes
backup_id	Unique identifier of current backup	string
current_step	Current step of operation	string	Enum: BACKUP_CREATING_CLUSTER_BACKUP, BACKUP_CREATING_NODE_BACKUP
current_step_message	Additional human-readable status information about current step	string
end_time	Time when operation is expected to end	EpochMsTimestamp
operation_type	Type of operation that is in progress. Returns none if no operation is in progress, in which case none of the other fields will be set.	string	Required Enum: NONE, BACKUP
start_time	Time when operation was started	EpochMsTimestamp

CustomAttributeAction (schema)

Request Parameters for Custom Context Profile Attributes

Request Parameter which specify action to either add or remove the custom values.

Name	Description	Type	Notes
action	Add or Remove Custom Context Profile Attribute values. Action parameter determines whether to add or remove Custom Context Profile Attribute values.	string	Required Enum: add, remove

CustomPolicyLbPersistenceProfile (schema)

PolicyLbPersistenceProflie for Custom type PolicyLbVirtualServer

Some applications maintain state and require all relevant connections
to be sent to the same server as the application state is not
synchronized among servers. Persistence is enabled on a PolicyLbVirtualServer
by binding a persistence profile to it.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
persistence	Persistence method used by PolicyLbVirtualServer(s) This field indicates the persistence method used for the PolicyLbVirtualServer. - COOKIE persistence allows related client connections, identified by the same cookie in HTTP requests [Refer to HTTP Cookie for details on HTTP cookies], to be redirected to the same server. Load balancer does not maintain any persistence table for cookie persistence. Instead, it encodes the necessary information in the HTTP cookie value sent to client and relies on the client to store it and send it back in subsequent related HTTP requests. Hence there is no limit on the number of cookie persistence entries that can be supported. - SOURCE_IP persistence ensures all connections from a client (identified by IP address) are sent to the same backend server for a specified period. - This object is not required and without creation of this object the virtual server persistence is disabled by default	string	Required Enum: COOKIE, SOURCE_IP
persistence_shared	Persistence shared across PolicyLbVirtualServers Persistence shared setting indicates that all PolicyLbVirtualServers that consume this PolicyLbPersistenceProfile should share the same persistence mechanism when enabled. Meaning, persistence entries of a client accessing one virtual server will also affect the same client's connections to a different virtual server. For example, say there are two virtual servers vip-ip1:80 and vip-ip1:8080 bound to the same Group g1 consisting of two servers (s11:80 and s12:80). By default, each virtual server will have its own persistence table or cookie. So, in the earlier example, there will be two tables (vip-ip1:80, p1) and (vip-ip1:8080, p1) or cookies. So, if a client connects to vip1:80 and later connects to vip1:8080, the second connection may be sent to a different server than the first. When persistence_shared is enabled, then the second connection will always connect to the same server as the original connection. For COOKIE persistence type, the same cookie will be shared by multiple virtual servers. For SOURCE_IP persistenct type, the persistence table will be shared across virtual servers.	boolean	Default: "False"
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value CustomPolicyLbPersistenceProfile	string	Required Enum: L4PolicyLbPersistenceProfile, L7PolicyLbPersistenceProfile, CustomPolicyLbPersistenceProfile
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

CustomPolicyLbVirtualServer (schema)

PolicyLbVirtualServer handling connections over HTTP or HTTPS

Virtual server acts as a facade to an application, receives all client
connections over a specified protocol and distributes them among the backend
servers. This custom type allows for more complex settings than the
simplified PolicyLbVirtualServer types. This object allows for complex
configurations for PolicyLbVirtualServers of all types. All HTTP
specific inputs will be rejected when combined with TPC or UDP protocols.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
access_log_enabled	Access log enabled setting If access log is enabled, all HTTP requests sent to an L7 virtual server are logged to the access log file. Both successful requests (backend server returns 2xx) and unsuccessful requests (backend server returns 4xx or 5xx) are logged to access log, if enabled.	boolean	Default: "False"
app_protocol	Application protocol for receiving client connections As the custom type allows for more complex settings than the simplified PolicyLbVirtualServer types, also specify the desired protocol for receiving all client connections.	string	Required Enum: TCP, UDP, HTTP, HTTPS
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
client_ssl_certificate_ids	ssl certificates Client-side SSL profile binding allows multiple certificates, for different hostnames, to be bound to the same virtual server. The setting is used when load balancer acts as an SSL server and terminating the client SSL connection	array of string
client_ssl_settings	Security profile setting Security settings representing various security settings when the VirtualServer acts as an SSL server - BASE_SECURE_111317 - MODERATE_SECURE_111317 - HIGH_SECURE_111317	string	Enum: BASE_SECURE_111317, MODERATE_SECURE_111317, HIGH_SECURE_111317 Default: "HIGH_SECURE_111317"
default_client_ssl_certificate_id	ssl certificate The setting is used when load balancer acts as an SSL server and terminating the client SSL connection. A default certificate should be specified which will be used if the server does not host multiple hostnames on the same IP address or if the client does not support SNI extension.	string
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	Sortable
insert_client_ip_header	Relative path of this object Backend web servers typically log each request they handle along with the requesting client IP address. These logs are used for debugging, analytics and other such purposes. If the deployment topology requires enabling SNAT on the load balancer, then server will see the client as the SNAT IP which defeats the purpose of logging. To work around this issue, load balancer can be configured to insert XFF HTTP header with the original client IP address. Backend servers can then be configured to log the IP address in XFF header instead of the source IP address of the connection. If XFF header is not present in the incoming request, load balancer inserts a new XFF header with the client IP address.	boolean	Default: "False"
ip_address	IP address of the PolicyLbVirtualServer Configures the IP address of the PolicyLbVirtualServer where it receives all client connections and distributes them among the backend servers.	IPAddress	Required
lb_persistence_profile	Persistence Profile used by PolicyLbVirtualServer Path to optional object that enables persistence on a virtual server allowing related client connections to be sent to the same backend server. Persistence is disabled by default.	string
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
ports	Virtual server port number(s) or port range(s) Ports contains a list of at least one port or port range such as "80", "1234-1236". Each port element in the list should be a single port or a single port range.	array of PortElement	Required
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value CustomPolicyLbVirtualServer	string	Required Enum: TcpPolicyLbVirtualServer, UdpPolicyLbVirtualServer, HttpPolicyLbVirtualServer, HttpsPolicyLbVirtualServer, CustomPolicyLbVirtualServer
router_path	Path to router type object for PolicyLbVirtualServer Path to router type object that PolicyLbVirtualServer connects to. The only supported router object is Network.	string	Required
server_auth_ca_certificate_ids	ssl certificate To support client authentication (load balancer acting as a client authenticating to the backend server), server_ssl_certificate_id can be specified. When supplied, the backend server certificate must be signed by one of the trusted Certificate Authorities (CAs), also referred to as root CAs, whose self signed certificates are specified. This setting is only applicable for L7 protocols and will be rejected in combination with TCP or UDP.	array of string
server_ssl_settings	Security profile setting Indicates whether to enable server side SSL. Server side SSL will be enabled when a specific security setting is selected. The selected security setting or profile represents various configurations related to SSL when the VirtualServer acts as a client connecting over SSL to the backend server. This setting is only applicable for L7 protocols and will be rejected in combination with TCP or UDP. - BASE_SECURE_111317 - MODERATE_SECURE_111317 - HIGH_SECURE_111317 - DISABLED	string	Enum: BASE_SECURE_111317, MODERATE_SECURE_111317, HIGH_SECURE_111317, DISABLED Default: "DISABLED"
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
traffic_source		string
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

CustomWidgetConfiguration (schema)

Custom widget Configuration

Represents configuration for custom widget. For this widget the data source is not applicable. It defines ui identifer to identify UI component and render it on dashboard view. This configuration can only be used for system owned widgets.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
datasources	Array of Datasource Instances with their relative urls The 'datasources' represent the sources from which data will be fetched. Currently, only NSX-API is supported as a 'default' datasource. An example of specifying 'default' datasource along with the urls to fetch data from is given at 'example_request' section of 'CreateWidgetConfiguration' API.	array of Datasource	Minimum items: 0
default_filter_value	Default filter value to be passed to datasources Default filter values to be passed to datasources. This will be used when the report is requested without filter values.	array of DefaultFilterValue
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Widget Title Title of the widget. If display_name is omitted, the widget will be shown without a title.	string	Maximum length: 255
drilldown_id	Id of drilldown widget Id of drilldown widget, if any. Id should be a valid id of an existing widget. A widget is considered as drilldown widget when it is associated with any other widget and provides more detailed information about any data item from the parent widget.	string	Maximum length: 255
feature_set	Features required to view the widget Features required to view the widget.	FeatureSet
filter	Id of filter widget for subscription Id of filter widget for subscription, if any. Id should be a valid id of an existing filter widget. Filter widget should be from the same view. Datasource URLs should have placeholder values equal to filter alias to accept the filter value on filter change.	string
filter_value_required	Flag to indicate if filter value is necessary Flag to indicate that widget will continue to work without filter value. If this flag is set to false then default_filter_value is manadatory.	boolean	Default: "True"
footer		Footer
icons	Icons Icons to be applied at dashboard for widgets and UI elements.	array of Icon
id	Unique identifier of this resource	string	Sortable
is_drilldown	Set as a drilldown widget Set to true if this widget should be used as a drilldown.	boolean	Default: "False"
legend	Legend for the widget Legend to be displayed. If legend is not needed, do not include it.	Legend
resource_type	Must be set to the value CustomWidgetConfiguration	string	Required Readonly Enum: LabelValueConfiguration, DonutConfiguration, MultiWidgetConfiguration, ContainerConfiguration, StatsConfiguration, GridConfiguration, GraphConfiguration, CustomWidgetConfiguration, DropdownFilterWidgetConfiguration Maximum length: 255
shared	Visiblity of widgets to other users Please use the property 'shared' of View instead of this. The widgets of a shared view are visible to other users.	boolean	Deprecated
span	Horizontal span Represents the horizontal span of the widget / container.	int	Minimum: 1 Maximum: 12
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
ui_component_identifier	UI identifier for component to be rendered inside view/container User defined component selector to be rendered inside view/container.	string
weight	Weightage or placement of the widget or container Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details.	int	Deprecated

CvxConnectionInfo (schema)

CVX Connection Info

Credential info to connect to a CVX type of enforcement point.

Name	Description	Type	Notes
enforcement_point_address	Enforcement Point Address Value of this property could be Hostname or IP. For instance: - On an NSX-T MP running on default port, the value could be "10.192.1.1" - On an NSX-T MP running on custom port, the value could be "192.168.1.1:32789" - On an NSX-T MP in VMC deployments, the value could be "192.168.1.1:5480/nsxapi"	string	Required
password	Password Password.	string	Required
resource_type	Must be set to the value CvxConnectionInfo	string	Required Enum: NSXTConnectionInfo, NSXVConnectionInfo, CvxConnectionInfo
thumbprint	Thumbprint of Enforcement Point Thumbprint of EnforcementPoint in the form of a SHA-256 hash represented in lower case HEX.	string
username	Username Username.	string	Required

DADMode (schema)

DAD Mode

Duplicate address detection modes.

Name	Description	Type	Notes
DADMode	DAD Mode Duplicate address detection modes.	string	Enum: LOOSE, STRICT

DADStatus (schema)

DAD Status

Duplicate address detection status for IP address on port.

Name	Description	Type	Notes
DADStatus	DAD Status Duplicate address detection status for IP address on port.	string	Enum: DUPLICATED, TENTATIVE, ASSIGNED, NOT_APPLICABLE, UNKNOWN

DNSForwarderStatisticsPerEnforcementPoint (schema)

DNS forwarder statistics per enforcement point

DNS forwarder statistics per enforcement point.
This is an abstract type. Concrete child types:
NsxTDNSForwarderStatistics

Name	Description	Type	Notes
enforcement_point_path	Enforcement point path Policy path referencing the enforcement point from where the statistics are fetched.	string	Readonly
resource_type		string	Required Enum: NsxTDNSForwarderStatistics

DNSForwarderStatusPerEnforcementPoint (schema)

DNS forwarder status per enforcement point

DNS forwarder status per enforcement point.
This is an abstract type. Concrete child types:
NsxTDNSForwarderStatus

Name	Description	Type	Notes
enforcement_point_path	Enforcement point path Policy path referencing the enforcement point from where the status is fetched.	string	Readonly
resource_type		string	Required Enum: NsxTDNSForwarderStatus

DataCounter (schema)

Name	Description	Type	Notes
dropped	The dropped packets or bytes	integer
multicast_broadcast	The multicast and broadcast packets or bytes	integer
total	The total packets or bytes	integer	Required

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

Datasource (schema)

Datasource Instance

An instance of a datasource configuration.

Name	Description	Type	Notes
display_name	Datasource instance's display name Name of a datasource instance.	string	Required Maximum length: 255
urls	Array of relative urls and their aliases Array of urls relative to the datasource configuration. For example, api/v1/fabric/nodes is a relative url of nsx-manager instance.	array of UrlAlias	Required

DatetimeUTC (schema)

Datetime string in UTC

Datetime string in UTC in the RFC3339 format 'yyyy-mm-ddThh:mm:ssZ'

Name	Description	Type	Notes
DatetimeUTC	Datetime string in UTC Datetime string in UTC in the RFC3339 format 'yyyy-mm-ddThh:mm:ssZ'	string

DefaultFilterValue (schema)

Default filter values

An instance of a datasource configuration.

Name	Description	Type	Notes
alias	Filter alias Filter alias.	string	Required
value	Filter default value Filter default value.	string	Required

DeleteRequestParameters (schema)

Parameters that affect how delete operations are processed

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"

DeploymentZone (schema) (Deprecated)

Deployment zone

Logical grouping of enforcement points.
This is a deprecated type. DeploymentZone has been renamed to Site.
Use Site.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

DetachClusterParameters (schema)

Name	Description	Type	Notes
force		string	Enum: true, false
graceful-shutdown		string	Enum: true, false Default: "false"
ignore-repository-ip-check		string	Enum: true, false Default: "false"

DfwFirewallConfiguration (schema)

DFW Firewall related configurations

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
description	Description of this resource	string	Maximum length: 1024 Sortable
disable_auto_drafts	Auto draft disable flag To disable auto drafts, set it to true. By default, auto drafts are enabled.	boolean	Default: "False"
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
enable_firewall	Firewall enable flag If set to true, Firewall is enabled.	boolean	Default: "True"
id	Unique identifier of this resource	string	Sortable
idfw_enabled	Identity firewall enable flag If set to true, identity firewall is enabled.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 DfwFirewallConfiguration	string	Required Enum: DfwFirewallConfiguration
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

DhGroup (schema)

Diffie-Hellman groups

Diffie-Hellman groups represent algorithm used to derive shared
keys between IPSec VPN initiator and responder over an
unsecured network.
GROUP2 uses 1048-bit Modular Exponentiation (MODP) group.
GROUP5 uses 1536-bit MODP group.
GROUP14 uses 2048-bit MODP group.
GROUP15 uses 3072-bit MODP group.
GROUP16 uses 4096-bit MODP group.
GROUP19 uses 256-bit Random Elliptic Curve (ECP) group.
GROUP20 uses 384-bit Random ECP group.
GROUP21 uses 521-bit Random ECP group.

Name	Description	Type	Notes
DhGroup	Diffie-Hellman groups Diffie-Hellman groups represent algorithm used to derive shared keys between IPSec VPN initiator and responder over an unsecured network. GROUP2 uses 1048-bit Modular Exponentiation (MODP) group. GROUP5 uses 1536-bit MODP group. GROUP14 uses 2048-bit MODP group. GROUP15 uses 3072-bit MODP group. GROUP16 uses 4096-bit MODP group. GROUP19 uses 256-bit Random Elliptic Curve (ECP) group. GROUP20 uses 384-bit Random ECP group. GROUP21 uses 521-bit Random ECP group.	string	Enum: GROUP2, GROUP5, GROUP14, GROUP15, GROUP16, GROUP19, GROUP20, GROUP21

DhcpHeader (schema)

Name	Description	Type	Notes
op_code	Message op code / message type This is used to specify the general type of message. A client sending request to a server uses an op code of BOOTREQUEST, while a server replying uses an op code of BOOTREPLY.	string	Enum: BOOTREQUEST, BOOTREPLY Default: "BOOTREQUEST"

DhcpIpPoolUsage (schema)

Name	Description	Type	Notes
allocated_number	allocated number. COULD BE INACCURATE, REFERENCE ONLY.	integer	Required
allocated_percentage	allocated percentage. COULD BE INACCURATE, REFERENCE ONLY.	integer	Required
dhcp_ip_pool_id	uuid of dhcp ip pool	string	Required
pool_size	pool size	integer	Required

DhcpLeasePerIP (schema)

Name	Description	Type	Notes
expire_time	expire time of the lease	string
ip_address	ip address of client	string	Required
lease_time	lease time of the ip address, in seconds	string
mac_address	mac address of client	string	Required
start_time	start time of lease	string	Required
subnet	subnet of client network	string

DhcpLeases (schema)

Name	Description	Type	Notes
dhcp_server_id	dhcp server uuid	string
leases	The lease info list of the server	array of DhcpLeasePerIP	Minimum items: 0 Maximum items: 65535
timestamp	timestamp of the lease info	EpochMsTimestamp

DhcpLeasesResult (schema)

Name	Description	Type	Notes
connectivity_path	Policy path to Segment, Tier0 or Tier1 gateway Policy path to Segment, Tier0 or Tier1 gateway where DHCP server is attached.	string
dhcp_server_id	dhcp server uuid	string
leases	The lease info list of the server	array of DhcpLeasePerIP	Minimum items: 0 Maximum items: 65535
timestamp	timestamp of the lease info	EpochMsTimestamp

DhcpOption121 (schema)

DHCP option 121

DHCP option 121 to define classless static route.

Name	Description	Type	Notes
static_routes	DHCP classless static routes Classless static route of DHCP option 121.	array of ClasslessStaticRoute	Required Minimum items: 1 Maximum items: 27

DhcpRelayConfig (schema)

DHCP relay configuration

DHCP relay configuration.
Please note, the realized-state of this entity returned by the
"GET /policy/api/v1/infra/realized-state/realized-entity" with this entity
policy-path is irrelevant with the application status of this entity.
Please do not rely on this returned realized-state to determine how this
dhcp-relay-config was applied. The dhcp realization information was
reflected in the realization states of the referencing Segment or T0/T1
gateway.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 DhcpRelayConfig	string
server_addresses	DHCP relay addresses DHCP server IP addresses for DHCP relay configuration. Both IPv4 and IPv6 addresses are supported.	array of IPAddress	Required Maximum items: 8
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

DhcpRelayConfigListResult (schema)

Paged collection of DhcpRelayConfigs

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	DhcpRelayConfig results	array of DhcpRelayConfig	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

DhcpServerConfig (schema)

DHCP server configuration

DHCP server configuration.
Please note, the realized-state of this entity returned by the
"GET /policy/api/v1/infra/realized-state/realized-entity" with this entity
policy-path is irrelevant with the application status of this entity.
Please do not rely on this returned realized-state to determine how this
dhcp-server-config was applied. The dhcp realization information was
reflected in the realization states of the referencing Segment or T0/T1
gateway.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
edge_cluster_path	Edge cluster path Edge cluster path. Auto assigned if only one edge cluster is configured on enforcement-point. Modifying edge cluster will reallocate DHCP server to the new edge cluster. Please note that re-allocating edge-cluster will result in losing of all exisitng DHCP lease information. Change edge cluster only when losing DHCP leases is not a real problem, e.g. cross-site migration or failover and all client hosts will be reboot and get new IP addresses.	string
id	Unique identifier of this resource	string	Sortable
lease_time	IP address lease time in seconds IP address lease time in seconds.	integer	Minimum: 60 Maximum: 4294967295 Default: "86400"
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
preferred_edge_paths	Edge node path Policy paths to edge nodes on which the DHCP servers run. The first edge node is assigned as active edge, and second one as stanby edge. If only one edge node is specified, the DHCP servers will run without HA support. When this property is not specified, edge nodes are auto-assigned during realization of the DHCP server.	array of string	Maximum items: 2
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value DhcpServerConfig	string
server_address	DHCP server address in CIDR format DHCP server address in CIDR format. Prefix length should be less than or equal to 30. DHCP server is deployed as DHCP relay service. This property is deprecated, use server_addresses instead. Both properties cannot be specified together with different new values.	string	Deprecated
server_addresses	DHCP server address in CIDR format DHCP server address in CIDR format. Both IPv4 and IPv6 address families are supported. Prefix length should be less than or equal to 30 for IPv4 address family and less than or equal to 126 for IPv6. When not specified, IPv4 value is auto-assigned to 100.96.0.1/30. Ignored when this object is configured at a Segment.	array of string	Maximum items: 2
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

DhcpServerConfigListResult (schema)

Paged collection of DhcpServerConfigs

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	DhcpServerConfig results	array of DhcpServerConfig	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

DhcpServerLeaseRequestParameters (schema)

DHCP server lease request parameters

Name	Description	Type	Notes
address	IP or MAC address IP address, IP range or MAC address to retrieve specific lease information. Either a "address" or a "segment_path" can be provided, but not both in the same call.	string
connectivity_path	String Path of Tier0, Tier1 or Segment String Path of Tier0, Tier1 or Segment where DHCP server is deployed. Specify Tier0/Tier1 gateway path for DHCP server attached to the gateway. Segment path must be specified for local DHCP server configuration.	string	Required
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
enforcement_point_path	String Path of the enforcement point Enforcement point path. Required when multiple enforcement points are configured.	string
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
segment_path	Segment path to retrieve lease information Segment path to retrieve lease information. Either a "address" or a "segment_path" can be provided, but not both in the same call.	string
sort_ascending		boolean
sort_by	Field by which records are sorted	string
source	The data source The data source, either realtime or cached. If not provided, cached data is returned.	DataSourceType

DhcpServerRequestParameters (schema)

DHCP server list request parameters

Name	Description	Type	Notes
connectivity_path	String Path of Tier0, Tier1 or Segment String Path of Tier0, Tier1 or Segment where DHCP server is deployed. Specify Tier0/Tier1 gateway path for DHCP server attached to the gateway. Segment path must be specified for local DHCP server configuration.	string	Required
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
enforcement_point_path	String Path of the enforcement point Enforcement point path. Required when multiple enforcement points are configured.	string
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

DhcpServerState (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. Additional enums with more details on progress/success/error states are sent for edge node. The success states are NODE_READY and TRANSPORT_NODE_READY, pending states are {VM_DEPLOYMENT_QUEUED, VM_DEPLOYMENT_IN_PROGRESS, REGISTRATION_PENDING} and other values indicate failures. "in_sync" state indicates that the desired configuration has been received by the host to which it applies, but is not yet in effect. When the configuration is actually in effect, the state will change to "success". Please note, failed state is deprecated.	string	Required Readonly Enum: pending, in_progress, success, failed, partial_success, orphaned, unknown, error, in_sync, NOT_AVAILABLE, VM_DEPLOYMENT_QUEUED, VM_DEPLOYMENT_IN_PROGRESS, VM_DEPLOYMENT_FAILED, VM_POWER_ON_IN_PROGRESS, VM_POWER_ON_FAILED, REGISTRATION_PENDING, NODE_NOT_READY, NODE_READY, VM_POWER_OFF_IN_PROGRESS, VM_POWER_OFF_FAILED, VM_UNDEPLOY_IN_PROGRESS, VM_UNDEPLOY_FAILED, VM_UNDEPLOY_SUCCESSFUL, EDGE_CONFIG_ERROR, VM_DEPLOYMENT_RESTARTED, REGISTRATION_FAILED, TRANSPORT_NODE_SYNC_PENDING, TRANSPORT_NODE_CONFIGURATION_MISSING, EDGE_HARDWARE_NOT_SUPPORTED, MULTIPLE_OVERLAY_TZS_NOT_SUPPORTED, TN_OVERLAY_TZ_IN_USE_BY_EDGE_CLUSTER, TZ_ENDPOINTS_NOT_SPECIFIED, NO_PNIC_PREPARED_IN_EDGE, APPLIANCE_INTERNAL_ERROR, VTEP_DHCP_NOT_SUPPORTED, UNSUPPORTED_HOST_SWITCH_PROFILE, UPLINK_HOST_SWITCH_PROFILE_NOT_SPECIFIED, HOSTSWITCH_PROFILE_NOT_FOUND, LLDP_SEND_ENABLED_NOT_SUPPORTED, UNSUPPORTED_NAMED_TEAMING_POLICY, LBSRCID_NOT_SUPPORTED_FOR_EDGE_VM, LACP_NOT_SUPPORTED_FOR_EDGE_VM, STANDBY_UPLINKS_NOT_SUPPORTED_FOR_EDGE_VM, MULTIPLE_ACTIVE_UPLINKS_NOT_SUPPORTED_FOR_EDGE, UNSUPPORTED_LACP_LB_ALGO_FOR_NODE, EDGE_NODE_VERSION_NOT_SUPPORTED, NO_PNIC_SPECIFIED_IN_TN, INVALID_PNIC_DEVICE_NAME, TRANSPORT_NODE_READY, VM_NETWORK_EDIT_PENDING, UNSUPPORTED_DEFAULT_TEAMING_POLICY, MPA_DISCONNECTED, VM_RENAME_PENDING, VM_CONFIG_EDIT_PENDING, VM_NETWORK_EDIT_FAILED, VM_RENAME_FAILED, VM_CONFIG_EDIT_FAILED, VM_CONFIG_DISCREPANCY, VM_NODE_REFRESH_FAILED, VM_PLACEMENT_REFRESH_FAILED, REGISTRATION_TIMEDOUT, REPLACE_FAILED, UPLINK_FROM_TEAMING_POLICY_NOT_MAPPED, LOGICAL_SWITCH_NAMED_TEAMING_HAS_NO_PNIC_BACKING, DELETE_VM_IN_REDEPLOY_FAILED, DEPLOY_VM_IN_REDEPLOY_FAILED, INSUFFICIENT_RESOURCES_IN_EDGE_NODE_FOR_SERVICE

DhcpServerStatistics (schema)

Name	Description	Type	Notes
acks	The total number of DHCP ACK packets	integer	Required
declines	The total number of DHCP DECLINE packets	integer	Required
dhcp_server_id	dhcp server uuid	string	Required
discovers	The total number of DHCP DISCOVER packets	integer	Required
errors	The total number of DHCP errors	integer	Required
informs	The total number of DHCP INFORM packets	integer	Required
ip_pool_stats	The DHCP ip pool usage statistics	array of DhcpIpPoolUsage
nacks	The total number of DHCP NACK packets	integer	Required
offers	The total number of DHCP OFFER packets	integer	Required
releases	The total number of DHCP RELEASE packets	integer	Required
requests	The total number of DHCP REQUEST packets	integer	Required
timestamp	timestamp of the statistics	EpochMsTimestamp	Required

DhcpServerStatus (schema)

Name	Description	Type	Notes
active_node	uuid of active transport node	string	Required
error_message	Error message, if available	string
service_status	UP means the dhcp service is working fine on both active transport-node and stand-by transport-node (if have), hence fail-over can work at this time if there is failure happens on one of the transport-node; DOWN means the dhcp service is down on both active transport-node and stand-by node (if have), hence the dhcp-service will not repsonse any dhcp request; Error means error happens on transport-node(s) or no status is reported from transport-node(s). The dhcp service may be working (or not working); NO_STANDBY means dhcp service is working in one of the transport node while not in the other transport-node (if have). Hence if the dhcp service in the working transport-node is down, fail-over will not happen and the dhcp service will go down.	string	Required Enum: UP, DOWN, ERROR, NO_STANDBY
stand_by_node	uuid of stand_by transport node. null if non-HA mode	string

DhcpStaticBindingConfig (schema)

Base class for DHCP options

DHCP IPv4 and IPv6 static bindings are extended from this abstract class.
This is an abstract type. Concrete child types:
DhcpV4StaticBindingConfig
DhcpV6StaticBindingConfig

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 DhcpStaticBindingConfig	string	Required Enum: DhcpV4StaticBindingConfig, DhcpV6StaticBindingConfig
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

DhcpStaticBindingConfigListResult (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Paginated list of DhcpStaticBindingConfig	array of DhcpStaticBindingConfig (Abstract type: pass one of the following concrete types) DhcpV4StaticBindingConfig DhcpV6StaticBindingConfig	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

DhcpStaticBindingState (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. Additional enums with more details on progress/success/error states are sent for edge node. The success states are NODE_READY and TRANSPORT_NODE_READY, pending states are {VM_DEPLOYMENT_QUEUED, VM_DEPLOYMENT_IN_PROGRESS, REGISTRATION_PENDING} and other values indicate failures. "in_sync" state indicates that the desired configuration has been received by the host to which it applies, but is not yet in effect. When the configuration is actually in effect, the state will change to "success". Please note, failed state is deprecated.	string	Required Readonly Enum: pending, in_progress, success, failed, partial_success, orphaned, unknown, error, in_sync, NOT_AVAILABLE, VM_DEPLOYMENT_QUEUED, VM_DEPLOYMENT_IN_PROGRESS, VM_DEPLOYMENT_FAILED, VM_POWER_ON_IN_PROGRESS, VM_POWER_ON_FAILED, REGISTRATION_PENDING, NODE_NOT_READY, NODE_READY, VM_POWER_OFF_IN_PROGRESS, VM_POWER_OFF_FAILED, VM_UNDEPLOY_IN_PROGRESS, VM_UNDEPLOY_FAILED, VM_UNDEPLOY_SUCCESSFUL, EDGE_CONFIG_ERROR, VM_DEPLOYMENT_RESTARTED, REGISTRATION_FAILED, TRANSPORT_NODE_SYNC_PENDING, TRANSPORT_NODE_CONFIGURATION_MISSING, EDGE_HARDWARE_NOT_SUPPORTED, MULTIPLE_OVERLAY_TZS_NOT_SUPPORTED, TN_OVERLAY_TZ_IN_USE_BY_EDGE_CLUSTER, TZ_ENDPOINTS_NOT_SPECIFIED, NO_PNIC_PREPARED_IN_EDGE, APPLIANCE_INTERNAL_ERROR, VTEP_DHCP_NOT_SUPPORTED, UNSUPPORTED_HOST_SWITCH_PROFILE, UPLINK_HOST_SWITCH_PROFILE_NOT_SPECIFIED, HOSTSWITCH_PROFILE_NOT_FOUND, LLDP_SEND_ENABLED_NOT_SUPPORTED, UNSUPPORTED_NAMED_TEAMING_POLICY, LBSRCID_NOT_SUPPORTED_FOR_EDGE_VM, LACP_NOT_SUPPORTED_FOR_EDGE_VM, STANDBY_UPLINKS_NOT_SUPPORTED_FOR_EDGE_VM, MULTIPLE_ACTIVE_UPLINKS_NOT_SUPPORTED_FOR_EDGE, UNSUPPORTED_LACP_LB_ALGO_FOR_NODE, EDGE_NODE_VERSION_NOT_SUPPORTED, NO_PNIC_SPECIFIED_IN_TN, INVALID_PNIC_DEVICE_NAME, TRANSPORT_NODE_READY, VM_NETWORK_EDIT_PENDING, UNSUPPORTED_DEFAULT_TEAMING_POLICY, MPA_DISCONNECTED, VM_RENAME_PENDING, VM_CONFIG_EDIT_PENDING, VM_NETWORK_EDIT_FAILED, VM_RENAME_FAILED, VM_CONFIG_EDIT_FAILED, VM_CONFIG_DISCREPANCY, VM_NODE_REFRESH_FAILED, VM_PLACEMENT_REFRESH_FAILED, REGISTRATION_TIMEDOUT, REPLACE_FAILED, UPLINK_FROM_TEAMING_POLICY_NOT_MAPPED, LOGICAL_SWITCH_NAMED_TEAMING_HAS_NO_PNIC_BACKING, DELETE_VM_IN_REDEPLOY_FAILED, DEPLOY_VM_IN_REDEPLOY_FAILED, INSUFFICIENT_RESOURCES_IN_EDGE_NODE_FOR_SERVICE

DhcpStatistics (schema)

Name	Description	Type	Notes
acks	The total number of DHCP ACK packets	integer	Required
declines	The total number of DHCP DECLINE packets	integer	Required
dhcp_server_id	dhcp server uuid	string	Required
discovers	The total number of DHCP DISCOVER packets	integer	Required
errors	The total number of DHCP errors	integer	Required
informs	The total number of DHCP INFORM packets	integer	Required
ip_pool_stats	The DHCP ip pool usage statistics	array of DhcpIpPoolUsage
nacks	The total number of DHCP NACK packets	integer	Required
offers	The total number of DHCP OFFER packets	integer	Required
releases	The total number of DHCP RELEASE packets	integer	Required
requests	The total number of DHCP REQUEST packets	integer	Required
timestamp	timestamp of the statistics	EpochMsTimestamp	Required

DhcpV4Options (schema)

DHCP options for IPv4 address family

DHCP options for IPv4 server.

Name	Description	Type	Notes
option121	DHCP option 121 DHCP option 121 to define classless static routes.	DhcpOption121
others	Other DHCP options To define DHCP options other than option 121 in generic format. Please note, only the following options can be defined in generic format. Those other options will be accepted without validation but will not take effect. -------------------------- Code Name -------------------------- 2 Time Offset 6 Domain Name Server 13 Boot File Size 19 Forward On/Off 26 MTU Interface 28 Broadcast Address 35 ARP Timeout 40 NIS Domain 41 NIS Servers 42 NTP Servers 44 NETBIOS Name Srv 45 NETBIOS Dist Srv 46 NETBIOS Node Type 47 NETBIOS Scope 58 Renewal Time 59 Rebinding Time 64 NIS+-Domain-Name 65 NIS+-Server-Addr 66 TFTP Server-Name (used by PXE) 67 Bootfile-Name (used by PXE) 93 PXE: Client system architecture 94 PXE: Client NDI 97 PXE: UUID/UNDI 117 Name Service Search 119 Domain Search 150 TFTP server address (used by PXE) 175 Etherboot 209 PXE Configuration File 210 PXE Path Prefix 211 PXE Reboot Time	array of GenericDhcpOption	Minimum items: 0 Maximum items: 255

DhcpV4StaticBindingConfig (schema)

DHCP static binding

DHCP IPv4 static bindings are configured for each segment.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
gateway_address	Gateway IP address When not specified, gateway address is auto-assigned from segment configuration.	IPv4Address
host_name	Host name Hostname to assign to the host.	string	Maximum length: 63
id	Unique identifier of this resource	string	Sortable
ip_address	IP assigned to host IP assigned to host. The IP address must belong to the subnet, if any, configured on Segment.	IPv4Address	Required
lease_time	Lease time DHCP lease time in seconds.	integer	Minimum: 60 Maximum: 4294967295 Default: "86400"
mac_address	MAC address of host MAC address of the host.	MACAddress	Required
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
options	DHCP options IPv4 DHCP options.	DhcpV4Options
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 DhcpV4StaticBindingConfig	string	Required Enum: DhcpV4StaticBindingConfig, DhcpV6StaticBindingConfig
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

DhcpV6StaticBindingConfig (schema)

DHCP static binding

DHCP IPv6 static bindings are configured for each segment.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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
dns_nameservers	DNS nameservers to be set to client host When not specified, no DNS nameserver will be set to client host.	array of string	Minimum items: 0 Maximum items: 2
domain_names	Domain names to be assigned to client host When not specified, no domain name will be assigned to client host.	array of string
id	Unique identifier of this resource	string	Sortable
ip_addresses	IP addresses to be assigned to client host When not specified, no ip address will be assigned to client host.	array of IPv6Address	Minimum items: 0 Maximum items: 1
lease_time	Lease time Lease time, in seconds.	integer	Minimum: 60 Maximum: 4294967295 Default: "86400"
mac_address	MAC address The MAC address of the client host. Either client-duid or mac-address, but not both.	MACAddress	Required
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
preferred_time	Preferred time Preferred time, in seconds. If this value is not provided, the value of lease_time*0.8 will be used.	integer	Minimum: 48 Maximum: 4294967295
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value DhcpV6StaticBindingConfig	string	Required Enum: DhcpV4StaticBindingConfig, DhcpV6StaticBindingConfig
sntp_servers	SNTP server ips SNTP server IP addresses.	array of IPv6Address	Minimum items: 0 Maximum items: 2
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

Dhcpv6Header (schema)

Name	Description	Type	Notes
msg_type	DHCP message type This is used to specify the DHCP v6 message. To request the assignment of one or more IPv6 addresses, a client first locates a DHCP server and then requests the assignment of addresses and other configuration information from the server. The client sends a Solicit message to the All_DHCP_Relay_Agents_and_Servers address to find available DHCP servers. Any server that can meet the client's requirements responds with an Advertise message. The client then chooses one of the servers and sends a Request message to the server asking for confirmed assignment of addresses and other configuration information. The server responds with a Reply message that contains the confirmed addresses and configuration. SOLICIT - A client sends a Solicit message to locate servers. ADVERTISE - A server sends and Advertise message to indicate that it is available. REQUEST - A client sends a Request message to request configuration parameters. REPLY - A server sends a Reply message containing assigned addresses and configuration parameters.	string	Enum: SOLICIT, ADVERTISE, REQUEST, REPLY Default: "SOLICIT"

DiscoveredNode (schema)

Name	Description	Type	Notes
_last_sync_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
certificate	Certificate of the discovered node	string
cm_local_id	Local Id of the discovered node in the Compute Manager	string	Required Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
external_id	External id of the discovered node, ex. a mo-ref from VC	string	Required Readonly
hardware_id	Hardware Id of the discovered node Hardware Id is generated using system hardware info. It is used to retrieve fabric node of the esx.	string	Readonly
ip_addresses	IP Addresses of the the discovered node.	array of IPAddress	Required Readonly
node_type	Discovered Node type like Host	string	Required Readonly
origin_id	Id of the compute manager from where this node was discovered	string	Required Readonly
origin_properties	Key-Value map of additional specific properties of discovered node in the Compute Manager	array of KeyValuePair	Readonly
os_type	OS type of the discovered node	string	Readonly
os_version	OS version of the discovered node	string	Readonly
parent_compute_collection	External id of the compute collection to which this node belongs	string	Readonly
resource_type	Must be set to the value DiscoveredNode	string	Required
stateless	Specifies whether host is stateless The stateless property describes whether host persists its state across reboot or not. If state persists, value is set as false otherwise true.	boolean	Readonly
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

DiscoveredResource (schema)

Base class for resources that are discovered and automatically updated

This is an abstract type. Concrete child types:
DistributedVirtualPortgroup
DistributedVirtualSwitch
VirtualPortgroup
VirtualSwitch

Name	Description	Type	Notes
_last_sync_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
resource_type	The type of this resource.	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

DiscoveryProfileBindingMap (schema)

Base Discovery Profile Binding 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.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 DiscoveryProfileBindingMap	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

DistributedFloodProtectionProfile (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
enable_rst_spoofing	Flag to indicate rst spoofing is enabled If set to true, rst spoofing will be enabled. Flag is used only for distributed firewall profiles.	boolean	Default: "False"
enable_syncache	Flag to indicate syncache is enabled If set to true, sync cache will be enabled. Flag is used only for distributed firewall profiles.	boolean	Default: "False"
icmp_active_flow_limit	Active ICMP connections limit If this field is empty, firewall will not set a limit to active ICMP connections.	integer	Minimum: 1 Maximum: 1000000
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
other_active_conn_limit	Timeout after first TN If this field is empty, firewall will not set a limit to other active connections. besides UDP, ICMP and half open TCP connections.	integer	Minimum: 1 Maximum: 1000000
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 DistributedFloodProtectionProfile	FloodProtectionProfileResourceType	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
tcp_half_open_conn_limit	Active half open TCP connections limit If this field is empty, firewall will not set a limit to half open TCP connections.	integer	Minimum: 1 Maximum: 1000000
udp_active_flow_limit	Active UDP connections limit If this field is empty, firewall will not set a limit to active UDP connections.	integer	Minimum: 1 Maximum: 1000000
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

DistributedVirtualPortgroup (schema)

Distributed virtual portgroup on a VC

Name	Description	Type	Notes
_last_sync_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
backing_type	Backing type for portgroup For distributed virtual portgroup, backing type is standard. For logical switch portgroup, the backing type is set to nsx.	string
cm_local_id	Id of the portgroup in compute manager Id of the portgroup, eg. a mo-ref from VC.	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
external_id	External id of the virtual portgroup	string	Required Readonly
key	Generated UUID of the portgroup	string
origin_type	Portgroup type like DistributedVirtualPortgroup	string	Readonly
overall_status	General status of the virtual portgroup This parameters reflects the managed entity status of the portgroup as reported by VC.	string	Readonly Enum: RED, YELLOW, GREEN, GRAY
resource_type	Must be set to the value DistributedVirtualPortgroup	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

DistributedVirtualSwitch (schema)

DistributedVirtualSwitch on a VC

Name	Description	Type	Notes
_last_sync_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cm_local_id	ID of the virtual switch in compute manager	string	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
discovered_nodes	Array of discovered nodes connected Array of discovered nodes connected to this switch.	array of DiscoveredNode	Readonly
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
external_id	External id of the virtual switch	string	Required Readonly
lacp_group_configs	Array of Link Aggregation Control Protocol (LACP) configuration It contains information about VMware specific multiple dynamic LACP groups.	array of LacpGroupConfigInfo
origin_id	ID of the compute manager ID of the compute manager where this virtual switch is discovered.	string	Readonly
origin_properties	Key-Value map of additional properties of switch	array of KeyValuePair	Readonly
origin_type	Switch type like VmwareDistributedVirtualSwitch	string	Readonly
resource_type	Must be set to the value DistributedVirtualSwitch	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
uplink_port_names	Uplink port names The uniform name of uplink ports on each host.	array of string	Readonly
uplink_portgroup	Uplink portgroup of distributed virtual switch	DistributedVirtualPortgroup	Readonly
uuid	UUID of the switch	string	Readonly

DnsHeader (schema)

Name	Description	Type	Notes
address	Domain name/IP to query/response This is used to define what is being asked or responded.	string
address_type	This is used to specify the type of the address. V4 - The address provided is an IPv4 domain name/IP address, the Type in query or response will be A V6 - The address provided is an IPv6 domain name/IP address, the Type in query or response will be AAAA	string	Enum: V4, V6 Default: "V4"
message_type	Specifies the message type whether it is a query or a response.	string	Enum: QUERY, RESPONSE Default: "QUERY"

DnsSecurityProfile (schema)

DNS security profile

Used to configure DNS security profile

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 DnsSecurityProfile	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
ttl	Time to live for DNS cache entry Time to live for DNS cache entry in seconds. Valid TTL values are between 3600 to 864000. However, this field accepts values between 0 through 864000. We define TTL type based on the value of TTL as follows: TTL 0 - cached entry never expires. TTL 1 to 3599 - invalid input and error is thrown TTL 3600 to 864000 - ttl is set to user input TTL field not set by user - TTL type is 'AUTO' and ttl value is set from DNS response packet. User defined TTL value is used only when it is betweeen 3600 to 864000.	integer	Minimum: 0 Maximum: 864000 Default: "86400"
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

DnsSecurityProfileBindingMap (schema)

Binding Map for DNS Security Profile

This entity will be used to establish association between DNS security profile and
Group. With this entity, user can specify intent for applying DNS security profile
profile to particular 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.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
profile_path	Profile Path PolicyPath of associated Profile	string	Required
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value DnsSecurityProfileBindingMap	string
sequence_number	Sequence number DNS Security Profile Binding Map Sequence number used to resolve conflicts betweeen two profiles applied on the same group. Lower sequence number takes higher precedence. Two binding maps applied to the same profile must have the same sequence number. User defined sequence numbers range from 1 through 100,000. System defined sequence numbers range from 100,001 through 200,000.	integer	Minimum: 1 Maximum: 100000
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

DnsSecurityProfileBindingMapListRequestParameters (schema)

DNS Security Profile Binding Map 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
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

DnsSecurityProfileBindingMapListResult (schema)

Paged collection of DNS Security Profile Binding 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	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	DNS Security Profile Binding Map List Results	array of DnsSecurityProfileBindingMap
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

DnsSecurityProfileListResult (schema)

Paged Collection of DnsSecurityProfile

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	DnsSecurityProfile list results	array of DnsSecurityProfile	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Domain (schema)

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.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource (Abstract type: pass one of the following concrete types) ChildDomainDeploymentMap ChildForwardingPolicy ChildGatewayPolicy ChildGroup ChildSecurityPolicy
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

DomainDeploymentMap (schema)

Domain Deployment Map

Binding of domain 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.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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 shall be enforced.	string	Required
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

DomainDeploymentMapListRequestParameters (schema)

Domain Deployment Map List Request Parameters

Domain Deployment Map 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
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

DomainDeploymentMapListResult (schema)

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	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Domain Deployment Map List Result Domain Deployment Map list result.	array of DomainDeploymentMap	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

DomainListRequestParameters (schema)

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
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

DomainListResult (schema)

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	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Domain list results	array of Domain	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

DonutConfiguration (schema)

Donut Configuration

Represents configuration of a Donut

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
count	Expression to retrieve count to be shown on Donut Expression to retrieve count to be shown on Donut.	string
datasources	Array of Datasource Instances with their relative urls The 'datasources' represent the sources from which data will be fetched. Currently, only NSX-API is supported as a 'default' datasource. An example of specifying 'default' datasource along with the urls to fetch data from is given at 'example_request' section of 'CreateWidgetConfiguration' API.	array of Datasource	Minimum items: 0
default_filter_value	Default filter value to be passed to datasources Default filter values to be passed to datasources. This will be used when the report is requested without filter values.	array of DefaultFilterValue
description	Description of this resource	string	Maximum length: 1024 Sortable
display_count	Show or hide the count of entities If true, displays the count of entities in the donut	boolean	Default: "True"
display_name	Widget Title Title of the widget. If display_name is omitted, the widget will be shown without a title.	string	Maximum length: 255
drilldown_id	Id of drilldown widget Id of drilldown widget, if any. Id should be a valid id of an existing widget. A widget is considered as drilldown widget when it is associated with any other widget and provides more detailed information about any data item from the parent widget.	string	Maximum length: 255
feature_set	Features required to view the widget Features required to view the widget.	FeatureSet
filter	Id of filter widget for subscription Id of filter widget for subscription, if any. Id should be a valid id of an existing filter widget. Filter widget should be from the same view. Datasource URLs should have placeholder values equal to filter alias to accept the filter value on filter change.	string
filter_value_required	Flag to indicate if filter value is necessary Flag to indicate that widget will continue to work without filter value. If this flag is set to false then default_filter_value is manadatory.	boolean	Default: "True"
footer		Footer
icons	Icons Icons to be applied at dashboard for widgets and UI elements.	array of Icon
id	Unique identifier of this resource	string	Sortable
is_drilldown	Set as a drilldown widget Set to true if this widget should be used as a drilldown.	boolean	Default: "False"
label	Label of the Donut Configuration Displayed at the middle of the donut, by default. It labels the entities of donut.	Label
legend	Legend for the widget Legend to be displayed. If legend is not needed, do not include it.	Legend
navigation	Navigation to a specified UI page Hyperlink of the specified UI page that provides details.	string	Maximum length: 1024
resource_type	Must be set to the value DonutConfiguration	string	Required Readonly Enum: LabelValueConfiguration, DonutConfiguration, MultiWidgetConfiguration, ContainerConfiguration, StatsConfiguration, GridConfiguration, GraphConfiguration, CustomWidgetConfiguration, DropdownFilterWidgetConfiguration Maximum length: 255
sections	Sections	array of DonutSection	Required Minimum items: 1
shared	Visiblity of widgets to other users Please use the property 'shared' of View instead of this. The widgets of a shared view are visible to other users.	boolean	Deprecated
span	Horizontal span Represents the horizontal span of the widget / container.	int	Minimum: 1 Maximum: 12
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
weight	Weightage or placement of the widget or container Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details.	int	Deprecated

DonutPart (schema)

Portion of a donut or stats chart

Represents an entity or portion to be plotted on a donut or stats chart.

Name	Description	Type	Notes
condition	Expression for evaluating condition If the condition is met then the part will be displayed. Examples of expression syntax are provided under 'example_request' section of 'CreateWidgetConfiguration' API.	string
drilldown_id	Id of drilldown widget Id of drilldown widget, if any. Id should be a valid id of an existing widget. A widget is considered as drilldown widget when it is associated with any other widget and provides more detailed information about any data item from the parent widget.	string
field	Value of the portion or entity of donut or stats chart A numerical value that represents the portion or entity of the donut or stats chart.	string	Required Maximum length: 1024
hide_empty_legend	Hide the legend if the data for the part is not available If true, legend will be shown only if the data for the part is available. This is applicable only if legends are specified in widget configuration.	boolean	Default: "False"
label	Label of the portion or entity of donut or stats chart If a section 'template' holds this donut or stats part, then the label is auto-generated from the fetched field values after applying the template.	Label
navigation	Navigation to a specified UI page Hyperlink of the specified UI page that provides details. If drilldown_id is provided, then navigation cannot be used.	string
render_configuration	Render Configuration Additional rendering or conditional evaluation of the field values to be performed, if any.	array of RenderConfiguration	Minimum items: 0
tooltip	Multi-line tooltip Multi-line text to be shown on tooltip while hovering over the portion.	array of Tooltip	Minimum items: 0

DonutSection (schema)

Section of a donut or stats chart

Represents high level logical grouping of portions or segments of a donut / stats chart.

Name	Description	Type	Notes
parts	Parts of a donut / stats chart Array of portions or parts of the donut or stats chart.	array of DonutPart	Required Minimum items: 1
row_list_field	Field from which parts of the donut or stats chart are formed Field of the root of the api result set for forming parts.	string	Maximum length: 1024
template	Template, if any, for automatically forming the donut or stats parts If true, the section will be appled as template for forming parts. Only one part will be formed from each element of 'row_list_field'.	boolean	Default: "False"

DropdownFilterWidgetConfiguration (schema)

Dropdown Filter widget Configuration

Represents configuration for dropdown filter widget.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
alias	Alias to be used when emitting filter value Alias to be used when emitting filter value.	string
datasources	Array of Datasource Instances with their relative urls The 'datasources' represent the sources from which data will be fetched. Currently, only NSX-API is supported as a 'default' datasource. An example of specifying 'default' datasource along with the urls to fetch data from is given at 'example_request' section of 'CreateWidgetConfiguration' API.	array of Datasource	Minimum items: 0
default_filter_value	Default filter value to be passed to datasources Default filter values to be passed to datasources. This will be used when the report is requested without filter values.	array of DefaultFilterValue
default_value	Expression to specify default value Expression to specify default value of filter.	string
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Widget Title Title of the widget. If display_name is omitted, the widget will be shown without a title.	string	Maximum length: 255
drilldown_id	Id of drilldown widget Id of drilldown widget, if any. Id should be a valid id of an existing widget. A widget is considered as drilldown widget when it is associated with any other widget and provides more detailed information about any data item from the parent widget.	string	Maximum length: 255
dropdown_item	Definition for item of a dropdown Defines the item of a dropdown.	DropdownItem	Required
feature_set	Features required to view the widget Features required to view the widget.	FeatureSet
filter	Id of filter widget for subscription Id of filter widget for subscription, if any. Id should be a valid id of an existing filter widget. Filter widget should be from the same view. Datasource URLs should have placeholder values equal to filter alias to accept the filter value on filter change.	string
filter_value_required	Flag to indicate if filter value is necessary Flag to indicate that widget will continue to work without filter value. If this flag is set to false then default_filter_value is manadatory.	boolean	Default: "True"
footer		Footer
icons	Icons Icons to be applied at dashboard for widgets and UI elements.	array of Icon
id	Unique identifier of this resource	string	Sortable
is_drilldown	Set as a drilldown widget Set to true if this widget should be used as a drilldown.	boolean	Default: "False"
legend	Legend for the widget Legend to be displayed. If legend is not needed, do not include it.	Legend
placeholder_msg	Placeholder message to be shown in filter Placeholder message to be displayed in dropdown filter.	string
resource_type	Must be set to the value DropdownFilterWidgetConfiguration	string	Required Readonly Enum: LabelValueConfiguration, DonutConfiguration, MultiWidgetConfiguration, ContainerConfiguration, StatsConfiguration, GridConfiguration, GraphConfiguration, CustomWidgetConfiguration, DropdownFilterWidgetConfiguration Maximum length: 255
shared	Visiblity of widgets to other users Please use the property 'shared' of View instead of this. The widgets of a shared view are visible to other users.	boolean	Deprecated
span	Horizontal span Represents the horizontal span of the widget / container.	int	Minimum: 1 Maximum: 12
static_filter_condition	Expression for evaluating condition If the condition is met then the static filter will be added. If no condition is provided, then the static filters will be applied unconditionally.	string
static_filters	Additional static items to be added in dropdown filter Additional static items to be added in dropdown filter. Example can be 'ALL'.	array of StaticFilter
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
weight	Weightage or placement of the widget or container Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details.	int	Deprecated

DropdownItem (schema)

Dropdown item definition

Name	Description	Type	Notes
display_name	Display name for item to be displayed in dropdown expression to extract display name to be shown in the drop down.	string	Maximum length: 1024
field	Expression for dropdown items of filter An expression that represents the items of the dropdown filter.	string	Required
value	Value for item to be displayed in dropdown Value of filter inside dropdown filter.	string	Required

DscpTrustMode (schema)

Trust settings

When you select the Trusted mode the inner header DSCP value is applied
to the outer IP header for IP/IPv6 traffic. For non IP/IPv6 traffic,
the outer IP header takes the default value.Untrusted mode is supported
on overlay-based and VLAN-based logical port.

Name	Description	Type	Notes
DscpTrustMode	Trust settings When you select the Trusted mode the inner header DSCP value is applied to the outer IP header for IP/IPv6 traffic. For non IP/IPv6 traffic, the outer IP header takes the default value.Untrusted mode is supported on overlay-based and VLAN-based logical port.	string	Enum: TRUSTED, UNTRUSTED Default: "TRUSTED"

DuplicateAddressBindingEntry (schema)

Duplicate address binding information

Name	Description	Type	Notes
binding	Combination of IP-MAC-VLAN binding	PacketAddressClassifier
binding_timestamp	Timestamp of binding Timestamp at which the binding was discovered via snooping or manually specified by the user	EpochMsTimestamp
conflicting_port	ID of logical port with the same address binding Provides the ID of the port on which the same address bidning exists	string
source	Address binding source Source from which the address binding entry was obtained	AddressBindingSource	Default: "UNKNOWN"

DuplicateIPDetectionOptions (schema)

Controls duplicate IP detection options

Contains dupliacte IP detection related discovery options.

Name	Description	Type	Notes
duplicate_ip_detection_enabled	Duplicate IP detection Indicates whether duplicate IP detection should be enabled	boolean	Default: "False"

EPActionForDnsForwarderRequestParameters (schema)

Name	Description	Type	Notes
action	An action to be performed for DNS forwarder on EP The valid DNS forwarder actions to be performed on EP are, - clear_cache: Clear the current cache of the dns forwarder from specified enforcement point.	string	Required Enum: clear_cache
enforcement_point_path	An enforcement point path, on which the action is to be performed An enforcement point path, on which the action is to be performed. If not specified, default enforcement point path, /infra/sites/default/enforcement-points/default will be considered.	string	Default: "/infra/sites/default/enforcement-points/default"

EULAAcceptance (schema)

EULA acceptance status

Indicate the status of End User License Agreement acceptance

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
acceptance	End User License Agreement acceptance status Acceptance status of End User License Agreement	boolean	Required

EULAContent (schema)

EULA content

End User License Agreement content

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
content	End User License Agreement content Content of End User License Agreement	string	Required

EULAOutputFormatRequestParameters (schema)

Indicate output format of End User License Agreement content

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string
value_format	End User License Agreement content output format	string

EdgeConfigurationState (schema)

Configuration State for Edge and VPN entities.

This contains fields that captures state of Trackable entities.
Edge and VPN state entities extend this object.

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
pending_change_list	List of pending changes Request identifier of the API which modified the entity.	array of string	Readonly
state	Overall state of desired configuration Gives details of state of desired configuration. Additional enums with more details on progress/success/error states are sent for edge node. The success states are NODE_READY and TRANSPORT_NODE_READY, pending states are {VM_DEPLOYMENT_QUEUED, VM_DEPLOYMENT_IN_PROGRESS, REGISTRATION_PENDING} and other values indicate failures. "in_sync" state indicates that the desired configuration has been received by the host to which it applies, but is not yet in effect. When the configuration is actually in effect, the state will change to "success". Please note, failed state is deprecated.	string	Required Readonly Enum: pending, in_progress, success, failed, partial_success, orphaned, unknown, error, in_sync, NOT_AVAILABLE, VM_DEPLOYMENT_QUEUED, VM_DEPLOYMENT_IN_PROGRESS, VM_DEPLOYMENT_FAILED, VM_POWER_ON_IN_PROGRESS, VM_POWER_ON_FAILED, REGISTRATION_PENDING, NODE_NOT_READY, NODE_READY, VM_POWER_OFF_IN_PROGRESS, VM_POWER_OFF_FAILED, VM_UNDEPLOY_IN_PROGRESS, VM_UNDEPLOY_FAILED, VM_UNDEPLOY_SUCCESSFUL, EDGE_CONFIG_ERROR, VM_DEPLOYMENT_RESTARTED, REGISTRATION_FAILED, TRANSPORT_NODE_SYNC_PENDING, TRANSPORT_NODE_CONFIGURATION_MISSING, EDGE_HARDWARE_NOT_SUPPORTED, MULTIPLE_OVERLAY_TZS_NOT_SUPPORTED, TN_OVERLAY_TZ_IN_USE_BY_EDGE_CLUSTER, TZ_ENDPOINTS_NOT_SPECIFIED, NO_PNIC_PREPARED_IN_EDGE, APPLIANCE_INTERNAL_ERROR, VTEP_DHCP_NOT_SUPPORTED, UNSUPPORTED_HOST_SWITCH_PROFILE, UPLINK_HOST_SWITCH_PROFILE_NOT_SPECIFIED, HOSTSWITCH_PROFILE_NOT_FOUND, LLDP_SEND_ENABLED_NOT_SUPPORTED, UNSUPPORTED_NAMED_TEAMING_POLICY, LBSRCID_NOT_SUPPORTED_FOR_EDGE_VM, LACP_NOT_SUPPORTED_FOR_EDGE_VM, STANDBY_UPLINKS_NOT_SUPPORTED_FOR_EDGE_VM, MULTIPLE_ACTIVE_UPLINKS_NOT_SUPPORTED_FOR_EDGE, UNSUPPORTED_LACP_LB_ALGO_FOR_NODE, EDGE_NODE_VERSION_NOT_SUPPORTED, NO_PNIC_SPECIFIED_IN_TN, INVALID_PNIC_DEVICE_NAME, TRANSPORT_NODE_READY, VM_NETWORK_EDIT_PENDING, UNSUPPORTED_DEFAULT_TEAMING_POLICY, MPA_DISCONNECTED, VM_RENAME_PENDING, VM_CONFIG_EDIT_PENDING, VM_NETWORK_EDIT_FAILED, VM_RENAME_FAILED, VM_CONFIG_EDIT_FAILED, VM_CONFIG_DISCREPANCY, VM_NODE_REFRESH_FAILED, VM_PLACEMENT_REFRESH_FAILED, REGISTRATION_TIMEDOUT, REPLACE_FAILED, UPLINK_FROM_TEAMING_POLICY_NOT_MAPPED, LOGICAL_SWITCH_NAMED_TEAMING_HAS_NO_PNIC_BACKING, DELETE_VM_IN_REDEPLOY_FAILED, DEPLOY_VM_IN_REDEPLOY_FAILED, INSUFFICIENT_RESOURCES_IN_EDGE_NODE_FOR_SERVICE

EdgeTransportNodeDatapathMemoryPoolUsage (schema)

Usage of datapath memory pool

Datapath memory pool usage value.

Name	Description	Type	Notes
description	Description of the memory pool Description of the memory pool.	string	Readonly
name	Name of the datapath memory pool Name of the datapath memory pool as available on edge node CLI.	string	Readonly
usage	Percentage of memory pool in use Percentage of memory pool in use.	number	Readonly

EdgeTransportNodeDatapathMemoryUsage (schema)

Detailed view of the datapath memory usage. Details out the heap and per memory pool usage

Detailed view of the datapath memory usage. Details out the heap and per memory pool point in time usage.

Name	Description	Type	Notes
datapath_heap_usage	Percentage of heap memory in use Percentage of heap memory in use.	number	Readonly
datapath_mem_pools_usage		array of EdgeTransportNodeDatapathMemoryPoolUsage
highest_datapath_mem_pool_usage	Highest percentage usage value among datapath memory pools Highest percentage usage value among datapath memory pools.	number	Readonly
highest_datapath_mem_pool_usage_names		array of string

EdgeTransportNodeMemoryUsage (schema)

Memory usage details of edge node

Point in time usage of system, datapath, swap and cache memory in edge node.

Name	Description	Type	Notes
cache_usage	Percentage of RAM on the system that can be flushed out to disk Percentage of RAM on the system that can be flushed out to disk.	number	Readonly
datapath_mem_usage_details	Detailed view of the datapath memory usage. Details out the heap and per memory pool usage Detailed view of the datapath memory usage. Details out the heap and per memory pool point in time usage.	EdgeTransportNodeDatapathMemoryUsage	Readonly
datapath_total_usage	Percentage of memory in use by datapath processes Percentage of memory in use by datapath processes which includes RES and hugepage memory.	number	Readonly
swap_usage	Percentage of swap disk in use Percentage of swap disk in use.	number	Readonly
system_mem_usage	Percentage of RAM in use on edge node Percentage of RAM in use on edge node.	number	Readonly

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
current_version_node_summary	Mapping of current versions of nodes and counts of nodes at the respective versions.	NodeSummaryList	Readonly
details	Details about the upgrade status	string	Readonly
node_count_at_target_version	Count of nodes at target component version Number of nodes of the type and at the component version	int	Readonly
percent_complete	Indicator of upgrade progress in percentage	number	Required Readonly
pre_upgrade_status	Pre-upgrade status of the component-type	UpgradeChecksExecutionStatus	Readonly
status	Upgrade status of component	string	Required Readonly Enum: SUCCESS, FAILED, IN_PROGRESS, NOT_STARTED, PAUSING, PAUSED
target_component_version	Target component version	string	Readonly

EffectiveIPInfo (schema)

List of effective ip address along with site id

Name	Description	Type	Notes
effective_ips		array of IPElement	Required
site_id	Id of the site to which the effective IPs belong to	string	Required

EgressRateLimiter (schema)

A shaper that specifies egress rate properties in Mb/s

Name	Description	Type	Notes
average_bandwidth	Average bandwidth in Mb/s	int	Minimum: 0 Default: "0"
burst_size	Burst size in bytes	int	Minimum: 0 Default: "0"
enabled		boolean	Required
peak_bandwidth	Peak bandwidth in Mb/s	int	Minimum: 0 Default: "0"
resource_type	Must be set to the value EgressRateLimiter	string	Required Enum: IngressRateLimiter, IngressBroadcastRateLimiter, EgressRateLimiter Default: "IngressRateLimiter"

EndpointPolicy (schema)

Contains ordered list of Endpoint Rules

Ordered list of Endpoint Rules ordered by sequence number of the entries.
The maximum number of policies is 25.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
endpoint_rules	Endpoint Rules that are a part of this EndpointPolicy	array of EndpointRule
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 EndpointPolicy	string
sequence_number	Precedence to resolve conflicts across Domains This field is used to resolve conflicts between maps across domains.	int	Minimum: 0 Maximum: 499 Default: "0"
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

EndpointRule (schema)

Endpoint Rule for guest introspection.

Endpoint Rule comes from user configuration. User configures Endpoint Rule to specify what services are applied on the 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.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	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	Required Maximum items: 50
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 EndpointRule	string
sequence_number	Sequence number of this Entry This field is used to resolve conflicts between multiple entries under EndpointPolicy. It will be system default value when not specified by user.	int	Minimum: 0 Maximum: 499 Default: "0"
service_profiles	Names of service profiles The policy paths of service profiles are listed here. It pecifies what services are applied on the group. Currently only one is allowed.	array of string	Required Maximum items: 1
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

EnforcedStatusDetailsNsxT (schema)

NSX-T Enforced Realized Status Details

Detailed Realized Status of an intent object on an NSX-T type of enforcement point. This is
a detailed view of the Realized Status of an intent object from an NSX-T enforcement point
perspective.

Name	Description	Type	Notes
enforced_status_info	Enforced Realized Status Info Information about the realized status of the intent on this enforcement point. Some very recent changes may be excluded when preparing this information, which is indicated by Pending Changes Info.	EnforcedStatusInfoNsxT	Readonly
pending_changes_info	Pending Changes Info Information about pending changes, if any, that aren't reflected in the Enforced Realized Status.	PendingChangesInfoNsxT	Readonly

EnforcedStatusInfoNsxT (schema)

NSX-T Enforced Realized Status Information

Information about the realized status of the intent object on an NSX-T type of enforcement point.
Some very recent changes may be excluded when preparing this information, which is indicated by
Pending Changes Info. In addition to the realized status across all scopes, this information holds
details about enforced realized status per scope.

Name	Description	Type	Notes
enforced_status	Enforced Realized Status Consolidated Realized Status of an Intent object across all scopes of an NSX-T type of enforcement point.	EnforcedStatusNsxT	Readonly
enforced_status_per_scope	List of Enforced Realized Status per Scope List of Enforced Realized Status per Scope.	array of EnforcedStatusPerScopeNsxT (Abstract type: pass one of the following concrete types) TransportNodeSpanEnforcedStatus	Readonly

EnforcedStatusNsxT (schema)

NSX-T Enforced Status

NSX-T Enforced Status.

Name	Description	Type	Notes
status	Enforced Realized Status Enforced Realized Status.	RuntimeState	Readonly
status_message	Status Message Status Message conveying hints depending on the status value.	string	Readonly

EnforcedStatusPerScopeNsxT (schema)

NSX-T Enforced Realized Status Per Scope

NSX-T Detailed Realized Status Per Scope.
This is an abstract type. Concrete child types:
TransportNodeSpanEnforcedStatus

Name	Description	Type	Notes
resource_type	Resource Type Enforced Realized Status Per Scope Resource Type.	string	Required Readonly Enum: TransportNodeSpanEnforcedStatus

EnforcedStatusPerTransportNode (schema)

Enforced Realized Status Per Transport Node

Detailed Realized Status Per Transport Node.

Name	Description	Type	Notes
display_name	Transport Node Display Name Display name of the transport node.	string	Readonly
enforced_status	Enforced Realized Status Realized Status of an Intent object on this Transport Node.	EnforcedStatusNsxT	Readonly
nsx_id	Transport Node Identifier UUID identifying uniquely the Transport Node.	string	Readonly
path	Transport Node Path Policy Path referencing the transport node.	string	Readonly

EnforcementPoint (schema)

Enforcement Point

Enforcement point is the endpoint where policy configurations are 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.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
auto_enforce	Auto Enforce Flag Auto enforce flag suggests whether the policy objects shall be automatically enforced on this enforcement point or not. When this flag is set to true, all policy objects will be automatically enforced on this enforcement point. If this flag is set to false, user shall rely on the usual means of realization, i.e., deployment maps.	boolean	Default: "True"
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource (Abstract type: pass one of the following concrete types) ChildPolicyEdgeCluster ChildPolicyTransportZone
connection_info	Enforcement Point Connection Info Connection Info of the Enforcement Point.	EnforcementPointConnectionInfo (Abstract type: pass one of the following concrete types) CvxConnectionInfo 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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly
version	Enforcement point Version Version of the Enforcement point.	string	Readonly

EnforcementPointConnectionInfo (schema)

Enforcement Point Connection Info

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

Name	Description	Type	Notes
enforcement_point_address	Enforcement Point Address Value of this property could be Hostname or IP. For instance: - On an NSX-T MP running on default port, the value could be "10.192.1.1" - On an NSX-T MP running on custom port, the value could be "192.168.1.1:32789" - On an NSX-T MP in VMC deployments, the value could be "192.168.1.1:5480/nsxapi"	string	Required
resource_type	Connection Info Resource Type Resource Type of Enforcement Point Connection Info.	string	Required Enum: NSXTConnectionInfo, NSXVConnectionInfo, CvxConnectionInfo

EnforcementPointListRequestParameters (schema)

Enforcement Point List Request Parameters

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
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

EnforcementPointListResult (schema)

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	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Enforcement Point List Results Enforcement Point list Results.	array of EnforcementPoint	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

EntityInstanceCountConstraintExpression (schema)

Represents the leaf level constraint to restrict the number instances of type.

Represents the leaf level constraint to restrict the number instances of an entity
type can be created. This is useful in restricting number of CGWs or MGWs or
Providers that can created in a system.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
count	Instance count. Instance count.	integer	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	Sortable
operator	Operations supported '<' and '<='.	string	Required
resource_type	Must be set to the value EntityInstanceCountConstraintExpression	string	Required Enum: ValueConstraintExpression, RelatedAttributeConditionalExpression, EntityInstanceCountConstraintExpression, FieldSanityConstraintExpression
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

EpochMsTimestamp (schema)

Timestamp in milliseconds since epoch

Name	Description	Type	Notes
EpochMsTimestamp	Timestamp in milliseconds since epoch	integer

ErrorResolverInfo (schema)

Metadata related to a given error_id

Name	Description	Type	Notes
error_id	The error id for which metadata information is needed	integer	Required
resolver_present	Indicates whether there is a resolver associated with the error or not	boolean	Required
user_metadata	User supplied metadata that might be required by the resolver	ErrorResolverUserMetadata

ErrorResolverInfoList (schema)

Collection of all registered ErrorResolverInfo

Name	Description	Type	Notes
results	ErrorResolverInfo list	array of ErrorResolverInfo	Required

ErrorResolverMetadata (schema)

Error along with its metadata

Name	Description	Type	Notes
entity_id	The entity/node UUID where the error has occurred.	string	Required
error_id	The error id as reported by the entity where the error occurred.	integer	Required
system_metadata	This can come from some external system like syslog collector	ErrorResolverSystemMetadata
user_metadata	User supplied metadata that might be required by the resolver	ErrorResolverUserMetadata

ErrorResolverMetadataList (schema)

List of errors with their metadata

Name	Description	Type	Notes
errors	List of errors with their corresponding metadata.	array of ErrorResolverMetadata	Required

ErrorResolverSystemMetadata (schema)

Metadata fetched from an external system like Syslog or LogInsight.

Name	Description	Type	Notes
value	The value fetched from another system	string

ErrorResolverUserInputData (schema)

Corresponds to one property entered by the user

Name	Description	Type	Notes
data_type	The datatype of the given property. Useful for data validation	string	Required Enum: TEXT, NUMBER, PASSWORD
property_name	Name of the property supplied by the user	string	Required
property_value	The value associated with the above property	string

ErrorResolverUserMetadata (schema)

User supplied metadata needed for resolving errors

Name	Description	Type	Notes
user_input_list	List of user supplied input data.	array of ErrorResolverUserInputData

EtherTypeServiceEntry (schema)

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.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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: IPProtocolServiceEntry, IGMPTypeServiceEntry, ICMPTypeServiceEntry, ALGTypeServiceEntry, L4PortSetServiceEntry, EtherTypeServiceEntry, NestedServiceServiceEntry
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

EthernetHeader (schema)

Name	Description	Type	Notes
dst_mac	Destination MAC address of the Ethernet header The destination MAC address of form: "^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$". For example: 00:00:00:00:00:00.	string
eth_type	The value of the type field to be put into the Ethernet header This field defaults to IPv4.	integer	Minimum: 1 Maximum: 65535 Default: "2048"
src_mac	Source MAC address of the Ethernet header The source MAC address of form: "^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$". For example: 00:00:00:00:00:00.	string

Evaluation (schema)

Criterion Evaluation

Criterion Evaluation is the basic logical condition to evaluate
whether the event could be potentially met.
This is an abstract type. Concrete child types:
SourceFieldEvaluation

Name	Description	Type	Notes
resource_type	Resource Type Criterion Evaluation resource type.	string	Required Enum: SourceFieldEvaluation

Event (schema)

Reaction Event

The Event is the criterion or criteria applied to the source and,
when met, prompt Policy to run the action.
All Reaction Events are constructed with reference to
the object, the "source", that is logically deemed to be the
object upon which the Event in question initially occurred upon.
Some example events include:
- New object was created.
- Change in realization state.
- Specific API is called.

Name	Description	Type	Notes
criteria	Event Criteria Criteria applied to the source and, if satisfied, would trigger the action. Criteria is composed of criterions. In order for the Criteria to be met, only one of the criterion must be fulfilled (implicit OR).	array of Criterion
source	Event Source Source that is logically deemed to be the "object" upon which the Event in question initially occurred upon.	Source (Abstract type: pass one of the following concrete types) ApiRequestBody ResourceOperation	Required

EvpnConfig (schema)

Evpn Configuration

Evpn Configuration.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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
encapsulation_method	Encapsulation method for EVPN. Encapsulation method for EVPN service that is used by the transport layer.	EvpnEncapConfig
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
mode	EVPN service mode In INLINE mode, edge nodes participate both in the BGP EVPN control plane route exchange and in data path tunneling between edge nodes and data center gateways. In ROUTE_SERVER mode, edge nodes participate in the BGP EVPN control plane route exchanges only and do not participate in the data forwarding, i.e., the data path tunnels are directly established between the hypervisors and the data center gateways. DISABLE mode disables EVPN service capability.	string	Enum: INLINE, ROUTE_SERVER, DISABLE Default: "DISABLE"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 EvpnConfig	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

EvpnEncapConfig (schema)

Encapsulation method for EVPN

Encapsulation method for EVPN.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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
evpn_tenant_config_path	EVPN tenant config path	string
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 EvpnEncapConfig	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly
vni_pool_path	vni pool path	string

EvpnTenantConfig (schema)

Evpn Tenant Configuration for Evpn in ROUTE-SERVER mode.

This resource is relevant only when Evpn Service is configured in ROUTE-SERVER mode.
The resource defines Vlans to VNIs mappings used by Evpn tenant VMs for overlay VXLAN transmission when attached
to vRouter. The resource contains overlay transport_zone_path and vni_pool_path to orchestrate creation of child Logical-Switches.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
mappings	VLANs to VNIs mapping spec This property specifies a mapping spec of incoming Evpn tenant vlan-ids to VXLAN VNIs used for overlay transmission to Physical-Gateways used by vRouters.	array of VlanVniRangePair	Required Minimum items: 1 Maximum items: 2000
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 EvpnTenantConfig	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
transport_zone_path	Policy path to the transport zone Policy path to transport zone. Only overlay transport zone is supported.	string	Required
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly
vni_pool_path	Policy path to the vni pool Policy path to the vni pool used for Evpn in ROUTE-SERVER mode.	string	Required

EvpnTunnelEndpointConfig (schema)

Evpn Tunnel Endpoint Configuration

Evpn Tunnel Endpoint Configuration.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
edge_path	edge path	string	Required
id	Unique identifier of this resource	string	Sortable
local_addresses	local addresses	array of IPv4Address	Required Minimum items: 1 Maximum items: 1
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
mtu	MTU	int	Minimum: 64 Maximum: 9100
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 EvpnTunnelEndpointConfig	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

ExportRequestParameter (schema)

Export task request parameters

This holds the request parameters required to invoke export task.

Name	Description	Type	Notes
draft_path	Policy path of draft Policy path of a draft which is to be exported. If not provided, current firewall configuration will then be exported.	string
passphrase	Passphrase to sign exported files Passphrase to sign exported files. The passphrase specified must be at least 8 characters in length and must contain at least one lowercase, one uppercase, one numeric character and one non-space special character.	string	Required Minimum length: 8 Pattern: "^$|^(?=.*[a-z])(?=.*[A-Z])(?=.*\d)(?=.*[^a-zA-Z\d\s]).{8,}$"

ExportTask (schema)

Export task information

This object holds the information of the export task.

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
async_response_available	True if response for asynchronous request is available	boolean	Readonly
cancelable	True if this task can be canceled	boolean	Readonly
description	Description of the task	string	Readonly
draft_path	Policy path of a draft Policy path of a draft if this is an export task to export draft configuration.	string	Readonly
end_time	The end time of the task in epoch milliseconds	EpochMsTimestamp	Readonly
exported_file	Name of the exported file Name of the exported file generated after completion of export task.	string	Readonly
failure_msg	Reason of the task failure This property holds the reason of the task failure, if any.	string	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

Expression (schema)

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
ExternalIDExpression
IPAddressExpression
IdentityGroupExpression
MACAddressExpression
NestedExpression
PathExpression

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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, ExternalIDExpression, PathExpression, IdentityGroupExpression
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

ExternalIDExpression (schema)

External ID expression node

Represents external ID expressions in the form of an array, to support addition of objects like virtual interfaces, virtual machines, CloudNativeServiceInstance PhysicalServer to 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.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
external_ids	Array of external IDs for the specified member type This array can consist of one or more external IDs for the specified member type.	array of string	Required Minimum items: 1
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
member_type	External ID member type	string	Required Enum: VirtualMachine, VirtualNetworkInterface, CloudNativeServiceInstance, PhysicalServer
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 ExternalIDExpression	string	Required Enum: Condition, ConjunctionOperator, NestedExpression, IPAddressExpression, MACAddressExpression, ExternalIDExpression, PathExpression, IdentityGroupExpression
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

FIPSGlobalConfig (schema)

Global configuration

Global configuration

Name	Description	Type	Notes
lb_fips_enabled	A flag to turn on or turn off the FIPS compliance of load balancer feature. When this flag is set to true FIPS mode will be set on ssl encryptions of load balancer feature.	boolean	Default: "False"

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

FeatureCompatibilityInfo (schema)

Feature Compatibility Info

Feature status information indicating site configuration compatibility with
global manager configuration.

Name	Description	Type	Notes
details		array of CompatibilityDetail	Readonly Maximum items: 10
feature		OnboardingFeatureInfo	Required Readonly
status	Compatibility Status	OnboardingCompatibilityStatus	Required Readonly

FeatureConflictInfo (schema)

Feature Conflict Info

Feature status information with number of conflicting entities and its total
count associated with the feature.

Name	Description	Type	Notes
conflict_count	Conflict Count Number of conflicting entities with global entities in the feature during an onboarding stage.	integer	Readonly
feature		OnboardingFeatureInfo	Readonly
total_count	Total Count Total number of entities in the feature during an onboarding stage.	integer	Readonly

FeaturePermission (schema)

Feature Permission

Name	Description	Type	Notes
feature	Feature Id	string	Required
feature_description	Feature Description	string
feature_name	Feature Name	string
is_execute_recommended	Is execute recommended	boolean	Readonly
is_internal	Is internal	boolean	Readonly
permission	Permission	string	Required Enum: crud, read, execute, none

FeaturePermissionArray (schema)

Name	Description	Type	Notes
feature_permissions	Array of FeaturePermission	array of FeaturePermission	Required

FeaturePermissionListResult (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	List results	array of FeaturePermission	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

FeaturePermissionRequestParameters (schema)

RBAC Objects qualifier

Name	Description	Type	Notes
feature_name	Feature name	string	Required
object_path	Exact object Policy path	string	Required

FeatureSet (schema)

List of features required to view the widget

Represents list of features required to view the widget.

Name	Description	Type	Notes
feature_list	List of features required for to view wdiget List of features required for to view widget.	array of string
require_all_permissions	Flag for specifying if permission to all features is required Flag for specifying if permission to all features is required If set to false, then if there is permission for any of the feature from feature list, widget will be available.	boolean

FeatureSummary (schema)

Feature Summary

Feature summary defining overall conflicting count against total number of
entities.

Name	Description	Type	Notes
total_conflict_count	Total Conflict Count Total number of conflicting entities with global entities accross all features during an onboarding stage.	integer	Readonly
total_count	Total Count Total number of entities across all features during an onboarding stage.	integer	Readonly

FeatureSummaryRequestParameters (schema)

Onboarding Feature Summary Request Parameters

Feature summary request parameters for a site.

Name	Description	Type	Notes
feature		UnsupportedFeature	Required Readonly

FederationComponentUpgradeStatus (schema)

Name	Description	Type	Notes
component_type	Component type for the upgrade status	string	Readonly
current_version_node_summary	Mapping of current versions of nodes and counts of nodes at the respective versions.	array of FederationNodeSummary	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
target_version	Target component version	string	Readonly

FederationConfig (schema)

Global Manager federation configuration

Global Manager federation configuration. This configuration is distributed
to all Sites participating in federation.

Name	Description	Type	Notes
site_config	Federation configurations of all Sites	array of SiteFederationConfig	Readonly

FederationConnectivityConfig (schema)

Federation connectivity configuration

Additional configuration required for federation.

Name	Description	Type	Notes
global_overlay_id	Auto generated federation global 24-bit id Global id for by Layer3 services for federation usecases.	integer	Readonly

FederationGatewayConfig (schema)

Federation gateway configuration

Additional gateway configuration required for federation

Name	Description	Type	Notes
global_overlay_id	Auto generated federation global 24-bit id Global id for by Layer3 services for federation usecases.	integer	Readonly
site_allocation_indices	Indicies for cross site allocation Indicies for cross site allocation for edge cluster and its members referred by gateway.	array of SiteAllocationIndexForEdge	Readonly
transit_segment_id	Auto generated federation global id for transit segment Global UUID for transit segment id to be used by Layer2 services for federation usecases.	string	Readonly

FederationInvalidConfigurationDetailsResponse (schema)

Federation Invalid Configuration Details Response

Name	Description	Type	Notes
feature	Feature information Federation feature with invalid configuration for onboarding a site.	OnboardingFeatureInfo	Readonly
invalid_config_summary		array of InvalidConfigSummary	Readonly Maximum items: 8
total_count	Total Resource Count Total resource count in invalid configuration.	integer	Required Readonly

FederationNodeSummary (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
node_count	Count of nodes Number of nodes of the type and at the component version.	int	Required Readonly
version	Component version	string	Required Readonly

FederationUpgradeSummary (schema)

Upgrade Summary

Provides upgrade summary for a specific site.

Name	Description	Type	Notes
component_status	List of component statuses	array of FederationComponentUpgradeStatus	Required Readonly
current_version	Current version of the site This is NSX version for the site.	string	Required Readonly
gpm_name	Name of the global manager Name of the global manager if present.	string	Readonly
id	UUID of this resource Unique identifier of this resource.	string	Required Readonly
last_upgrade_timestamp	Last upgrade timestamp Indicates the time when the site was upgraded.	string	Readonly
name	Name of the site Name of the site.	string	Readonly
overall_upgrade_status	Status of upgrade	string	Required Readonly Enum: SUCCESS, FAILED, IN_PROGRESS, NOT_STARTED, PAUSED
site_id	UUID of the site This is the Site Manager generated UUID for every NSX deployment.	string	Required Readonly
site_ip	Site IP IP address of the site.	string	Required Readonly
site_type	Site type Type of this site.	string	Required Readonly Enum: ACTIVE_GM_SITE, STANDBY_GM_SITE, NON_GM_SITE
target_version	Target version for the site This is NSX target version for the site, if it is undergoing upgrade.	string	Readonly

FederationUpgradeSummaryListRequestParameters (schema)

Name	Description	Type	Notes
current_version	Filter on site current_version Get upgrade information from sites are at a given version.	string
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

FederationUpgradeSummaryListResult (schema)

Paged Collection of site upgrade information

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
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 site upgrade information	array of FederationUpgradeSummary	Readonly
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

FieldSanityConstraintExpression (schema)

Represents the field value sanity constraint

Represents the field value constraint to constrain specified field
value based on defined sanity checks.
Example - For DNS.upstream_servers, all the IP addresses must either be
public or private.
{
"target": {
"target_resource_type": "DnsForwarderZone",
"attribute": "upstreamServers",
"path_prefix": "/infra/dns-forwarder-zones/"
},
"constraint_expression": {
"resource_type": "FieldSanityConstraintExpression",
"operator": "OR",
"checks": ["ALL_PUBLIC_IPS", "ALL_PRIVATE_IPS"]
}
}

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
checks	Array of sanity checks to be performed on field value List of sanity checks.	array of string	Required Enum: ALL_PUBLIC_IPS, ALL_PRIVATE_IPS
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	Sortable
operator	A conditional operator	string	Required Enum: OR, AND
resource_type	Must be set to the value FieldSanityConstraintExpression	string	Required Enum: ValueConstraintExpression, RelatedAttributeConditionalExpression, EntityInstanceCountConstraintExpression, FieldSanityConstraintExpression
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

FieldSetting (schema)

FieldSetting

Field Setting.

Name	Description	Type	Notes
field_pointer	Field Pointer Field Pointer.	string	Required
value	Value Value that the field must be set to.	FieldSettingValue (Abstract type: pass one of the following concrete types) ConstantFieldValue	Required

FieldSettingValue (schema)

Field Setting Value

Field Setting Value.
This is an abstract type. Concrete child types:
ConstantFieldValue

Name	Description	Type	Notes
resource_type	Resource Type Field Setting Value resource type.	string	Required Enum: ConstantFieldValue

FieldsFilterData (schema)

Name	Description	Type	Notes
ip_info	IP address information	IpInfo
resource_type	Must be set to the value FieldsFilterData	string	Required Enum: FieldsFilterData, PlainFilterData Default: "FieldsFilterData"
transport_info	Transport layer information	TransportInfo

FieldsPacketData (schema)

Name	Description	Type	Notes
arp_header	The ARP header	ArpHeader
eth_header	The ethernet header	EthernetHeader
frame_size	Requested total size of the (logical) packet in bytes If the requested frame_size is too small (given the payload and traceflow metadata requirement of 16 bytes), the traceflow request will fail with an appropriate message. The frame will be zero padded to the requested size.	integer	Minimum: 60 Maximum: 1000 Default: "128"
ip_header	The IPv4 header	Ipv4Header
ipv6_header	The IPv6 header	Ipv6Header
payload	RFC3548 compatible base64-encoded payload Up to 1000 bytes of payload may be supplied (with a base64-encoded length of 1336 bytes.) Additional bytes of traceflow metadata will be appended to the payload. The payload contains any data the user wants to put after the transport header.	string	Maximum length: 1336
resource_type	Must be set to the value FieldsPacketData	string	Required Enum: BinaryPacketData, FieldsPacketData Default: "FieldsPacketData"
routed	A flag, when set true, indicates that the traceflow packet is of L3 routing.	boolean
transport_header	The transport header This field contains a protocol that is above IP. It is not restricted to the 'transport' defined by the OSI model (e.g., ICMP is supported).	TransportProtocolHeader
transport_type	transport type of the traceflow packet	string	Enum: BROADCAST, UNICAST, MULTICAST, UNKNOWN Default: "UNICAST"

FileProperties (schema)

File properties

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
created_epoch_ms	File creation time in epoch milliseconds	integer	Required
modified_epoch_ms	File modification time in epoch milliseconds	integer	Required
name	File name	string	Required Pattern: "^[^/]+$"
size	Size of the file in bytes	integer	Required

FilePropertiesListResult (schema)

File properties query results

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	File property results	array of FileProperties	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

FileThumbprint (schema)

File thumbprint

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
name	File name	string	Required Pattern: "^[^/]+$"
sha1	File's SHA1 thumbprint	string	Required
sha256	File's SHA256 thumbprint	string	Required

FileTransferAuthenticationScheme (schema)

Remote server authentication details

Name	Description	Type	Notes
password	Password to authenticate with	string
scheme_name	Authentication scheme name	string	Required Enum: PASSWORD
username	User name to authenticate with	string	Required Pattern: "^([a-zA-Z][a-zA-Z0-9-.]*[a-zA-Z]\\\){0,1}\w[\w.-]+$"

FileTransferProtocol (schema)

Protocol to transfer backup file to remote server

Name	Description	Type	Notes
authentication_scheme	Scheme to authenticate if required	FileTransferAuthenticationScheme	Required
protocol_name	Protocol name	string	Required Enum: sftp Default: "sftp"
ssh_fingerprint	SSH fingerprint of server The expected SSH fingerprint of the server. If the server's fingerprint does not match this fingerprint, the connection will be terminated. Only ECDSA fingerprints hashed with SHA256 are supported. To obtain the host's ssh fingerprint, you should connect via some method other than SSH to obtain this information. You can use one of these commands to view the key's fingerprint: 1. ssh-keygen -l -E sha256 -f ssh_host_ecdsa_key.pub 2. awk '{print $2}' ssh_host_ecdsa_key.pub | base64 -d | sha256sum -b | sed 's/ .*$//' | xxd -r -p | base64 | sed 's/.//44g' | awk '{print "SHA256:"$1}'	string	Required Pattern: "^SHA256:.*$"

FilterWidgetConfiguration (schema)

Filter widget Configuration

Represents configuration for filter widget. This is abstract representation of filter widget.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
alias	Alias to be used when emitting filter value Alias to be used when emitting filter value.	string
datasources	Array of Datasource Instances with their relative urls The 'datasources' represent the sources from which data will be fetched. Currently, only NSX-API is supported as a 'default' datasource. An example of specifying 'default' datasource along with the urls to fetch data from is given at 'example_request' section of 'CreateWidgetConfiguration' API.	array of Datasource	Minimum items: 0
default_filter_value	Default filter value to be passed to datasources Default filter values to be passed to datasources. This will be used when the report is requested without filter values.	array of DefaultFilterValue
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Widget Title Title of the widget. If display_name is omitted, the widget will be shown without a title.	string	Maximum length: 255
drilldown_id	Id of drilldown widget Id of drilldown widget, if any. Id should be a valid id of an existing widget. A widget is considered as drilldown widget when it is associated with any other widget and provides more detailed information about any data item from the parent widget.	string	Maximum length: 255
feature_set	Features required to view the widget Features required to view the widget.	FeatureSet
filter	Id of filter widget for subscription Id of filter widget for subscription, if any. Id should be a valid id of an existing filter widget. Filter widget should be from the same view. Datasource URLs should have placeholder values equal to filter alias to accept the filter value on filter change.	string
filter_value_required	Flag to indicate if filter value is necessary Flag to indicate that widget will continue to work without filter value. If this flag is set to false then default_filter_value is manadatory.	boolean	Default: "True"
footer		Footer
icons	Icons Icons to be applied at dashboard for widgets and UI elements.	array of Icon
id	Unique identifier of this resource	string	Sortable
is_drilldown	Set as a drilldown widget Set to true if this widget should be used as a drilldown.	boolean	Default: "False"
legend	Legend for the widget Legend to be displayed. If legend is not needed, do not include it.	Legend
resource_type	Must be set to the value FilterWidgetConfiguration	string	Required Readonly Enum: LabelValueConfiguration, DonutConfiguration, MultiWidgetConfiguration, ContainerConfiguration, StatsConfiguration, GridConfiguration, GraphConfiguration, CustomWidgetConfiguration, DropdownFilterWidgetConfiguration Maximum length: 255
shared	Visiblity of widgets to other users Please use the property 'shared' of View instead of this. The widgets of a shared view are visible to other users.	boolean	Deprecated
span	Horizontal span Represents the horizontal span of the widget / container.	int	Minimum: 1 Maximum: 12
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
weight	Weightage or placement of the widget or container Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details.	int	Deprecated

FirewallConfiguration (schema)

Firewall related configurations

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
description	Description of this resource	string	Maximum length: 1024 Sortable
disable_auto_drafts	Auto draft disable flag To disable auto drafts, set it to true. By default, auto drafts are enabled.	boolean	Default: "False"
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
enable_firewall	Firewall enable flag If set to true, Firewall is enabled.	boolean	Default: "True"
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 FirewallConfiguration	string	Required Enum: DfwFirewallConfiguration
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

FloodProtectionProfile (schema)

Flood Protection profile

A profile holding TCP, UDP and ICMP and other protcol connection limits. This is an abstract type. Concrete child types:
DistributedFloodProtectionProfile
GatewayFloodProtectionProfile

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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_active_flow_limit	Active ICMP connections limit If this field is empty, firewall will not set a limit to active ICMP connections.	integer	Minimum: 1 Maximum: 1000000
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
other_active_conn_limit	Timeout after first TN If this field is empty, firewall will not set a limit to other active connections. besides UDP, ICMP and half open TCP connections.	integer	Minimum: 1 Maximum: 1000000
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 FloodProtectionProfile	FloodProtectionProfileResourceType	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
tcp_half_open_conn_limit	Active half open TCP connections limit If this field is empty, firewall will not set a limit to half open TCP connections.	integer	Minimum: 1 Maximum: 1000000
udp_active_flow_limit	Active UDP connections limit If this field is empty, firewall will not set a limit to active UDP connections.	integer	Minimum: 1 Maximum: 1000000
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

FloodProtectionProfileBindingListResult (schema)

Paged Collection of flood protection profile binding maps

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Flood protection profile binding maps list results	array of FloodProtectionProfileBindingMap	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

FloodProtectionProfileBindingMap (schema)

Policy Flood Protection Profile binding map

This entity will be used to establish association between Flood Protection
profile and Logical Routers.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
profile_path	Profile Path PolicyPath of associated Profile	string	Required
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value FloodProtectionProfileBindingMap	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

FloodProtectionProfileListRequestParameters (schema)

Flood Protection profile 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
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

FloodProtectionProfileListResult (schema)

Paged Collection of flood protection profiles

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Flood protection profile list results	array of FloodProtectionProfile (Abstract type: pass one of the following concrete types) DistributedFloodProtectionProfile GatewayFloodProtectionProfile	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

FloodProtectionProfileResourceType (schema)

Resource types of flood protection profiles

GatewayFloodProtectionProfile is used for all Tier0 and Tier1 gateways.
DistributedFloodProtectionProfile is used for all Transport Nodes.

Name	Description	Type	Notes
FloodProtectionProfileResourceType	Resource types of flood protection profiles GatewayFloodProtectionProfile is used for all Tier0 and Tier1 gateways. DistributedFloodProtectionProfile is used for all Transport Nodes.	string	Enum: GatewayFloodProtectionProfile, DistributedFloodProtectionProfile

Footer (schema)

Widget Footer

Footer of a widget that provides additional information or allows an action such as clickable url for navigation. An example usage of footer is provided under 'example_request' section of 'CreateWidgetConfiguration' API.

Name	Description	Type	Notes
actions	Footer Actions Action to be performed at the footer of a widget. An action at the footer can be simple text description or a hyperlink to a UI page. Action allows a clickable url for navigation. An example usage of footer action is provided under 'example_request' section of 'CreateWidgetConfiguration' API.	array of FooterAction	Minimum items: 0
condition	Expression for evaluating condition If the condition is met then the footer will be applied. Examples of expression syntax are provided under 'example_request' section of 'CreateWidgetConfiguration' API.	string	Maximum length: 1024

FooterAction (schema)

Widget Footer Action

Action specified at the footer of a widget to provide additional information or to provide a clickable url for navigation. An example usage of footer action is provided under the 'example_request' section of 'CreateWidgetConfiguration' API.

Name	Description	Type	Notes
dock_to_container_footer	Dock the footer at container If true, the footer will appear in the underlying container that holds the widget.	boolean	Default: "True"
label	Label for action Label to be displayed against the footer action.	Label	Required
url	Clickable hyperlink, if any Hyperlink to the UI page that provides details of action.	string	Maximum length: 1024

ForceRevisionCheckRequestParameter (schema)

Parameter to enforce revision check before updating objects

Forces revision check before updating

Name	Description	Type	Notes
enforce_revision_check	Force revision check If this is set to true, each child object in the request needs to have _revision property set correctly. System will honor the revision numbers while updating the resources.	boolean	Default: "False"

ForwardingPolicy (schema)

Forwarding Policy

Contains ordered list of forwarding rules that determine when to
forward traffic to / from the underlay for accessing cloud native services.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
category	A way to classify a security policy, if needed. - Distributed Firewall - Policy framework provides five pre-defined categories for classifying a security policy. They are "Ethernet","Emergency", "Infrastructure" "Environment" and "Application". There is a pre-determined order in which the policy framework manages the priority of these security policies. Ethernet category is for supporting layer 2 firewall rules. The other four categories are applicable for layer 3 rules. Amongst them, the Emergency category has the highest priority followed by Infrastructure, Environment and then Application rules. Administrator can choose to categorize a security policy into the above categories or can choose to leave it empty. If empty it will have the least precedence w.r.t the above four categories. - Edge Firewall - Policy Framework for Edge Firewall provides six pre-defined categories "Emergency", "SystemRules", "SharedPreRules", "LocalGatewayRules", "AutoServiceRules" and "Default", in order of priority of rules. All categories are allowed for Gatetway Policies that belong to 'default' Domain. However, for user created domains, category is restricted to "SharedPreRules" or "LocalGatewayRules" only. Also, the users can add/modify/delete rules from only the "SharedPreRules" and "LocalGatewayRules" categories. If user doesn't specify the category then defaulted to "Rules". System generated category is used by NSX created rules, for example BFD rules. Autoplumbed category used by NSX verticals to autoplumb data path rules. Finally, "Default" category is the placeholder default rules with lowest in the order of priority.	string
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource (Abstract type: pass one of the following concrete types) ChildForwardingRule
comments	SecurityPolicy lock/unlock comments Comments for security policy lock/unlock.	string
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
internal_sequence_number	Internal sequence number This field is to indicate the internal sequence number of a policy with respect to the policies across categories.	int	Readonly
is_default	Default policy flag A flag to indicate whether policy is a default policy.	boolean	Readonly
lock_modified_by	User who locked the security policy ID of the user who last modified the lock for the secruity policy.	string	Readonly
lock_modified_time	SecuirtyPolicy locked/unlocked time SecurityPolicy locked/unlocked time in epoch milliseconds.	EpochMsTimestamp	Readonly
locked	Lock a security policy Indicates whether a security policy should be locked. If the security policy is locked by a user, then no other user would be able to modify this security policy. Once the user releases the lock, other users can update this security policy.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 ForwardingPolicy	string
rule_count	Rule count The count of rules in the policy.	int	Readonly
rules	Rules that are a part of this ForwardingPolicy	array of ForwardingRule
scheduler_path	Path to the scheduler for time based scheduling Provides a mechanism to apply the rules in this policy for a specified time duration.	string
scope	The list of group paths where the rules in this policy will get applied. This scope will take precedence over rule level scope. Supported only for security and redirection policies. In case of RedirectionPolicy, it is expected only when the policy is NS and redirecting to service chain.	array of string	Maximum items: 128
sequence_number	Sequence number to resolve conflicts across Domains This field is used to resolve conflicts between security policies across domains. In order to change the sequence number of a policy one can fire a POST request on the policy entity with a query parameter action=revise The sequence number field will reflect the value of the computed sequence number upon execution of the above mentioned POST request. For scenarios where the administrator is using a template to update several security policies, the only way to set the sequence number is to explicitly specify the sequence number for each security policy. If no sequence number is specified in the payload, a value of 0 is assigned by default. If there are multiple policies with the same sequence number then their order is not deterministic. If a specific order of policies is desired, then one has to specify unique sequence numbers or use the POST request on the policy entity with a query parameter action=revise to let the framework assign a sequence number	int	Minimum: 0
stateful	Stateful nature of the entries within this security policy. Stateful or Stateless nature of security policy is enforced on all rules in this security policy. When it is stateful, the state of the network connects are tracked and a stateful packet inspection is performed. Layer3 security policies can be stateful or stateless. By default, they are stateful. Layer2 security policies can only be stateless.	boolean
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
tcp_strict	Enforce strict tcp handshake before allowing data packets Ensures that a 3 way TCP handshake is done before the data packets are sent. tcp_strict=true is supported only for stateful security policies. If the tcp_strict flag is not specified and the security policy is stateful, then tcp_strict will be set to true.	boolean
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

ForwardingPolicyListResult (schema)

Paged Collection of ForwardingPolicy objects

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	ForwardingPolicy list results	array of ForwardingPolicy	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

ForwardingRule (schema)

Forwarding rule

Forwarding rule that determine how to forward traffic from a VM.
Traffic from VM can either be routed via Overlay or Underlay when VM is on hybrid port.
Additionally NAT can be performed for VM or container on overlay to route traffic to/from underlay
ROUTE_TO_UNDERLAY - Access a service on underlay space from a VM connected to hybrid port. Eg access to AWS S3 on AWS underlay
ROUTE_TO_OVERLAY - Access a service on overlay space from a VM connected to hybrid port.
ROUTE_FROM_UNDERLAY - Access a service hosted on a VM (that is connected to hybrid port) from underlay space. Eg access from AWS ELB to VM
ROUTE_FROM_OVERLAY - Access a service hosted on a VM (that is connected to hybrid port) from overlay space
NAT_FROM_UNDERLAY - Access a service on overlay VM/container from underlay space using DNAT from underlay IP to overlay IP
NAT_TO_UNDERLAY - Access an underlay service from a VM/container on overlay space using SNAT from overlay IP to underlay IP

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
action	Action The action to be applied to all the services	string	Enum: ROUTE_TO_UNDERLAY, ROUTE_TO_OVERLAY, ROUTE_FROM_UNDERLAY, ROUTE_FROM_OVERLAY, NAT_FROM_UNDERLAY, NAT_TO_UNDERLAY
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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. Along with paths we support IP Address of type IPv4 and IPv6. IP Address can be in one of the format(CIDR, IP Address, Range of IP Address). 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	Maximum items: 128
destinations_excluded	Negation of destination groups If set to true, the rule gets applied on all the groups that are NOT part of the destination groups. If false, the rule applies to the destination groups	boolean	Default: "False"
direction	Direction Define direction of traffic.	string	Enum: IN, OUT, IN_OUT Default: "IN_OUT"
disabled	Flag to disable the rule Flag to disable the rule. Default is enabled.	boolean	Default: "False"
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
ip_protocol	IPv4 vs IPv6 packet type Type of IP packet that should be matched while enforcing the rule. The value is set to IPV4_IPV6 for Layer3 rule if not specified. For Layer2/Ether rule the value must be null.	string	Enum: IPV4, IPV6, IPV4_IPV6
is_default	Default rule flag A flag to indicate whether rule is a default rule.	boolean	Readonly
logged	Enable logging flag Flag to enable packet logging. Default is disabled.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
notes	Text for additional notes on changes Text for additional notes on changes.	string	Maximum length: 2048
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
profiles	Layer 7 service profiles Holds the list of layer 7 service profile paths. These profiles accept attributes and sub-attributes of various network services (e.g. L4 AppId, encryption algorithm, domain name, etc) as key value pairs.	array of string	Maximum items: 128
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value ForwardingRule	string
rule_id	Unique rule ID This is a unique 4 byte positive number that is assigned by the system. This rule id is passed all the way down to the data path. The first 1GB (1000 to 2^30) will be shared by GM and LM with zebra style striped number space. For E.g 1000 to (1Million -1) by LM, (1M - 2M-1) by GM and so on.	integer	Readonly
scope	The list of policy paths where the rule is applied LR/Edge/T0/T1/LRP etc. Note that a given rule can be applied on multiple LRs/LRPs.	array of string	Maximum items: 128
sequence_number	Sequence number of the this Rule This field is used to resolve conflicts between multiple Rules under Security or Gateway Policy for a Domain If no sequence number is specified in the payload, a value of 0 is assigned by default. If there are multiple rules with the same sequence number then their order is not deterministic. If a specific order of rules is desired, then one has to specify unique sequence numbers or use the POST request on the rule entity with a query parameter action=revise to let the framework assign a sequence number	int	Minimum: 0
service_entries	Raw services In order to specify raw services this can be used, along with services which contains path to services. This can be empty or null.	array of ServiceEntry (Abstract type: pass one of the following concrete types) ALGTypeServiceEntry EtherTypeServiceEntry ICMPTypeServiceEntry IGMPTypeServiceEntry IPProtocolServiceEntry L4PortSetServiceEntry NestedServiceServiceEntry	Maximum items: 128
services	Names of services 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	Maximum items: 128
source_groups	Source group paths We need paths as duplicate names may exist for groups under different domains. Along with paths we support IP Address of type IPv4 and IPv6. IP Address can be in one of the format(CIDR, IP Address, Range of IP Address). 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	Maximum items: 128
sources_excluded	Negation of source groups If set to true, the rule gets applied on all the groups that are NOT part of the source groups. If false, the rule applies to the source groups	boolean	Default: "False"
tag	Tag applied on the rule User level field which will be printed in CLI and packet logs.	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

ForwardingRuleListRequestParameters (schema)

ForwardingRule 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
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

ForwardingRuleListResult (schema)

Paged Collection of ForwardingRules

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Rule list results	array of ForwardingRule	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

FqdnAnalysisConfig (schema)

FQDN Analysis feature configuration entity

The type contains information about the configuration of the FqdnAnalysis feature for a
specific node.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
enabled	Enabled Property which specifies the enabling/disabling of the feature.	boolean	Default: "False"
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 FqdnAnalysisConfig	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

FullSyncState (schema)

Full sync state

Provides FullSync state for Local Manager from Global Manager.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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
errors	Errors occurred during full sync Errors occurred during full sync.	array of string	Readonly
full_sync_id	Full sync id Full sync id generated by Async Replicator (AR) service.	string	Readonly
id	Unique identifier of this resource	string	Sortable
last_completed_stage	Full sync stage that is last completed for this request. The current stage of full sync completion for ongoing sync. When Local Manager (LM) receives full sync data from AR, LM starts with workflow to prserve the state and restore the full sync from where it has left off in case of change of leadership of the service to different NSX node or LM is restarted. LM starts the full sync workflow with state INITIAL capturing the AR full sync id and data location details. The stage/state transition follows the order given below INITIAL - Full sync started PROCESSED_FULLSYNC_DATA - Compelted processing the full state data provided by AR PRCESSED_DELTAS - Completed processing pending delta changes provided by AR. DELETED_STALE_ENTITIES - Completed deletion of all global entities on LM that are not in GM anymore COMPLETED - Full sync handling is completed on LM ERROR - Full sync failed with errors on LM, in which case AR will re-attempt full sync later point in time for the LM ABORTED - Indicates that the full sync cancelled as per user request	string	Readonly Enum: INITIAL, PAUSE_DCNS, DELETED_STALE_ENTITIES, PROCESSED_FULLSYNC_DATA, PROCESSED_DELTAS, UNPAUSE_DCNS, COMPLETED, ERROR, ABORTED
last_upate_time	Timestamp of last update, could be progress or success or error.	EpochMsTimestamp	Readonly Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 FullSyncState	string
start_time	Timestamp of Full Sync start.	EpochMsTimestamp	Readonly Sortable
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

FullSyncStateListResult (schema)

Paged Collection of FullSync states.

Paged Collection of FullSync states.

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	FullSync states list FullSync states list.	array of FullSyncState	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

GatewayFloodProtectionProfile (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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_active_flow_limit	Active ICMP connections limit If this field is empty, firewall will not set a limit to active ICMP connections.	integer	Minimum: 1 Maximum: 1000000
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
nat_active_conn_limit	Maximum limit of active NAT connections The maximum limit of active NAT connections. This limit only apply to EDGE components (such as, gateway). If this property is omitted, or set to null, then there is no limit on the specific component. Meanwhile there is an implicit limit which depends on the underlying hardware resource.	integer	Minimum: 1 Maximum: 4294967295 Default: "4294967295"
other_active_conn_limit	Timeout after first TN If this field is empty, firewall will not set a limit to other active connections. besides UDP, ICMP and half open TCP connections.	integer	Minimum: 1 Maximum: 1000000
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 GatewayFloodProtectionProfile	FloodProtectionProfileResourceType	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
tcp_half_open_conn_limit	Active half open TCP connections limit If this field is empty, firewall will not set a limit to half open TCP connections.	integer	Minimum: 1 Maximum: 1000000
udp_active_flow_limit	Active UDP connections limit If this field is empty, firewall will not set a limit to active UDP connections.	integer	Minimum: 1 Maximum: 1000000
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

GatewayGeneralSecurityProfile (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
enable_double_flow	Flag to indicate double flow check is enabled or not The flag to indicate double flow check is enabled or not. This option applies only to EDGE components.	boolean	Default: "False"
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 GatewayGeneralSecurityProfile	GeneralSecurityProfileResourceType	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

GatewayPolicy (schema)

Contains ordered list of Rules for GatewayPolicy

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
category	A way to classify a security policy, if needed. - Distributed Firewall - Policy framework provides five pre-defined categories for classifying a security policy. They are "Ethernet","Emergency", "Infrastructure" "Environment" and "Application". There is a pre-determined order in which the policy framework manages the priority of these security policies. Ethernet category is for supporting layer 2 firewall rules. The other four categories are applicable for layer 3 rules. Amongst them, the Emergency category has the highest priority followed by Infrastructure, Environment and then Application rules. Administrator can choose to categorize a security policy into the above categories or can choose to leave it empty. If empty it will have the least precedence w.r.t the above four categories. - Edge Firewall - Policy Framework for Edge Firewall provides six pre-defined categories "Emergency", "SystemRules", "SharedPreRules", "LocalGatewayRules", "AutoServiceRules" and "Default", in order of priority of rules. All categories are allowed for Gatetway Policies that belong to 'default' Domain. However, for user created domains, category is restricted to "SharedPreRules" or "LocalGatewayRules" only. Also, the users can add/modify/delete rules from only the "SharedPreRules" and "LocalGatewayRules" categories. If user doesn't specify the category then defaulted to "Rules". System generated category is used by NSX created rules, for example BFD rules. Autoplumbed category used by NSX verticals to autoplumb data path rules. Finally, "Default" category is the placeholder default rules with lowest in the order of priority.	string
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource (Abstract type: pass one of the following concrete types) ChildRule
comments	SecurityPolicy lock/unlock comments Comments for security policy lock/unlock.	string
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
internal_sequence_number	Internal sequence number This field is to indicate the internal sequence number of a policy with respect to the policies across categories.	int	Readonly
is_default	Default policy flag A flag to indicate whether policy is a default policy.	boolean	Readonly
lock_modified_by	User who locked the security policy ID of the user who last modified the lock for the secruity policy.	string	Readonly
lock_modified_time	SecuirtyPolicy locked/unlocked time SecurityPolicy locked/unlocked time in epoch milliseconds.	EpochMsTimestamp	Readonly
locked	Lock a security policy Indicates whether a security policy should be locked. If the security policy is locked by a user, then no other user would be able to modify this security policy. Once the user releases the lock, other users can update this security policy.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 GatewayPolicy	string
rule_count	Rule count The count of rules in the policy.	int	Readonly
rules	Rules that are a part of this SecurityPolicy	array of Rule
scheduler_path	Path to the scheduler for time based scheduling Provides a mechanism to apply the rules in this policy for a specified time duration.	string
scope	The list of group paths where the rules in this policy will get applied. This scope will take precedence over rule level scope. Supported only for security and redirection policies. In case of RedirectionPolicy, it is expected only when the policy is NS and redirecting to service chain.	array of string	Maximum items: 128
sequence_number	Sequence number to resolve conflicts across Domains This field is used to resolve conflicts between security policies across domains. In order to change the sequence number of a policy one can fire a POST request on the policy entity with a query parameter action=revise The sequence number field will reflect the value of the computed sequence number upon execution of the above mentioned POST request. For scenarios where the administrator is using a template to update several security policies, the only way to set the sequence number is to explicitly specify the sequence number for each security policy. If no sequence number is specified in the payload, a value of 0 is assigned by default. If there are multiple policies with the same sequence number then their order is not deterministic. If a specific order of policies is desired, then one has to specify unique sequence numbers or use the POST request on the policy entity with a query parameter action=revise to let the framework assign a sequence number	int	Minimum: 0
stateful	Stateful nature of the entries within this security policy. Stateful or Stateless nature of security policy is enforced on all rules in this security policy. When it is stateful, the state of the network connects are tracked and a stateful packet inspection is performed. Layer3 security policies can be stateful or stateless. By default, they are stateful. Layer2 security policies can only be stateless.	boolean
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
tcp_strict	Enforce strict tcp handshake before allowing data packets Ensures that a 3 way TCP handshake is done before the data packets are sent. tcp_strict=true is supported only for stateful security policies. If the tcp_strict flag is not specified and the security policy is stateful, then tcp_strict will be set to true.	boolean
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

GatewayPolicyListResult (schema)

Paged Collection of gateway policies

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	GatewayPolicy list results	array of GatewayPolicy	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

GatewayQosProfile (schema)

QoS configuration of Tier1 gateway

QoS profile contains configuration of rate limiting properties which can be
applied in ingress and egress directions at Tier1 gateways

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
burst_size	Burst size in bytes Burst size in bytes.	int	Minimum: 1 Default: "1"
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
committed_bandwitdth	Committed bandwidth in Mbps Committed bandwidth in both directions specoficd in Mbps. Bandwidth is limited to line rate when the value configured is greater than line rate.	int	Minimum: 1 Default: "1"
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
excess_action	Action on traffic exceeding bandwidth. Action on traffic exceeding bandwidth.	string	Enum: DROP
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 GatewayQosProfile	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

GatewayQosProfileConfig (schema)

Gateway QoS profile configuration

Name	Description	Type	Notes
egress_qos_profile_path	Egress QoS profile Policy path to gateway QoS profile in egress direction.	string
ingress_qos_profile_path	Ingress QoS profile Policy path to gateway QoS profile in ingress direction.	string

GatewayQosProfileListResult (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Paginated list of GatewayQosProfile	array of GatewayQosProfile	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

GatewayRouteCsvRecord (schema)

Name	Description	Type	Notes
admin_distance	The admin distance of the next hop	integer
edge_path	Edge path Edge node policy path.	string	Readonly
interface	The policy path of the interface which is used as the next hop	string
lr_component_id	Logical router component(Service Router/Distributed Router) id	string
lr_component_type	Logical router component(Service Router/Distributed Router) type	string
network	CIDR network address	IPCIDRBlock	Required
next_hop	The IP of the next hop	IPAddress
route_type	Route type (USER, CONNECTED, NSX_INTERNAL,..)	string	Required

GatewayRouteTableInCsvFormat (schema)

Name	Description	Type	Notes
file_name	File name File name set by HTTP server if API returns CSV result as a file.	string
last_update_timestamp	Timestamp when the data was last updated; unset if data source has never updated the data.	EpochMsTimestamp	Readonly
results		array of GatewayRouteCsvRecord

GeneralSecurityProfile (schema)

General Security profile

A profile holding general security settings. This is an abstract type. Concrete child types:
GatewayGeneralSecurityProfile

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 GeneralSecurityProfile	GeneralSecurityProfileResourceType	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

GeneralSecurityProfileBindingMap (schema)

Policy General Security profile binding map

This entity will be used to establish association between General Security
profile and Logical Routers.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
profile_path	Profile Path PolicyPath of associated Profile	string	Required
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value GeneralSecurityProfileBindingMap	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

GeneralSecurityProfileResourceType (schema)

Resource types of General Security profiles

GatewayGeneralSecurityProfile is used for all Tier0 and Tier1 gateways.

Name	Description	Type	Notes
GeneralSecurityProfileResourceType	Resource types of General Security profiles GatewayGeneralSecurityProfile is used for all Tier0 and Tier1 gateways.	string	Enum: GatewayGeneralSecurityProfile

GenericDhcpOption (schema)

Generic DHCP option

Define DHCP options other than option 121.

Name	Description	Type	Notes
code	DHCP option code, [0-255] Code of the dhcp option.	integer	Required Minimum: 0 Maximum: 255
values	DHCP option value Value of the option.	array of string	Required Minimum items: 1 Maximum items: 10

GenericPolicyRealizedResource (schema)

Generic realized entity

Represents realized entity

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	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_point_path	Enforcement Point Path The path of the enforcement point.	string	Readonly
entity_type	Type of realized entity	string	Readonly
extended_attributes	Collection of type specific properties	array of AttributeVal	Readonly
id	Unique identifier of this resource	string	Sortable
intent_paths	Collection of intent paths	array of string	Readonly
intent_reference	Desire state paths of this object	array of string
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
realization_api	Realization API of this object on enforcement point	string
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 GenericPolicyRealizedResource	string
runtime_error	String representation of runtime error It define the root cause for runtime error.	string
runtime_status	String representation of runtime status Possible values could be UP, DOWN, UNKNOWN, DEGRADED This list is not exhaustive.	string
site_path	Site Path The site where this entity resides.	string	Readonly
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: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

GenericPolicyRealizedResourceListResult (schema)

GenericPolicyRealizedResource list result

GenericPolicyRealizedResource list result

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Paged Collection of GenericPolicyRealizedResources List of realized resources	array of GenericPolicyRealizedResource
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

GetBackupUiFramesInfoRequestParameters (schema)

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string
ui_tab_type		string	Readonly Enum: LOCAL_MANAGER_TAB, GLOBAL_MANAGER_TAB Default: "LOCAL_MANAGER_TAB"

GetCertParameter (schema)

Name	Description	Type	Notes
details	whether to expand the pem data and show all its details	boolean	Default: "False"

GetSNMPParameters (schema)

Get SNMP request parameters

Get SNMP request parameters.

Name	Description	Type	Notes
show_sensitive_data	Show SNMP sensitive data or not Whether to show SNMP service properties including community strings if any applicable.	boolean	Default: "False"

GlobalCollectorConfig (schema)

Abstract base type for Global collector configurations of different types

The GlobalCollectorConfig is the base class for global collector configurations for
different types in a NSX domain.
This is an abstract type. Concrete child types:
VrniGlobalCollector
WaveFrontGlobalCollector

Name	Description	Type	Notes
collector_ip	IP address for the global collector collector IP address for the global collector.	IPAddress	Required
collector_port	Port for the global collector Port for the global collector.	int	Required Minimum: 0 Maximum: 65535
collector_type	Specify the global collector type.	GlobalCollectorType	Required

GlobalCollectorType (schema)

Valid Global collector types

Name	Description	Type	Notes
GlobalCollectorType	Valid Global collector types	string	Enum: VRNI, WAVE_FRONT

GlobalConfig (schema)

Global configuration

Global configuration

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
allow_changing_vdr_mac_in_use	A flag to indicate if changing the VDR MAC being used is allowed When this flag is set to true, it is allowed to change the VDR MAC being used by existing transport nodes in a NSX system. The VDR MAC used by a host switch in a transport node is decided by the OVERLAY transport zone(s) which the host switch joins. If any of the OVERLAY transport zone(s) has "nested_nsx" property set to true, the MAC in "vdr_mac_nested" is used; otherwise the MAC in "vdr_mac" is used. Thus the VDR MAC being used by a host switch in a transport node can be changed in below ways. If the host switch is not in any OVERLAY transport zone whose "nested_nsx" property is true but is in an OVERLAY transport zone, the first way is updating the "vdr_mac" property. The 2nd way is updating one of the OVERLAY tranport zones joined by the host switch to set "nested_nsx" property true which will make the host switch use the VDR MAC in "vdr_mac_nested". The third way is directly updating the transport node to add an OVERLAY transport zone whose "nested_nsx" property is true into the host switch which will also make the host switch use the VDR MAC in "vdr_mac_nested". If the host switch is in some OVERLAY transport zone(s) whose "nested_nsx" property is true, the first way is updating the "vdr_mac_nested" property. The 2nd way is updating all those OVERLAY tranport zones to set "nested_nsx" property false which will make the host switch use the VDR MAC in "vdr_mac". The third way is directly updating the transport node to remove all those OVERLAY transport zones from the host switch which will also make the host switch use the VDR MAC in "vdr_mac". Please note that changing the VDR MAC being used by existing transport nodes will most likely cause traffic disruption and network outage!	boolean	Default: "False"
arp_limit_per_gateway	ARP limit per Tier0/Tier1 gateway Global configuration of maximum number of ARP entries per transport node at each Tier0/Tier1 gateway.	int	Minimum: 5000 Maximum: 50000
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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
fips	FIPS enabled config Contains the FIPSGlobalConfig object.	FIPSGlobalConfig
id	Unique identifier of this resource	string	Sortable
l3_forwarding_mode	L3 forwarding mode Configure forwarding mode for routing. This setting does not restrict configuration for other modes.	string	Enum: IPV4_ONLY, IPV4_AND_IPV6 Default: "IPV4_ONLY"
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
mtu	MTU size Maximum transmission unit (MTU) specifies the size of the largest packet that a network protocol can transmit.	int	Minimum: 1280
operation_collectors	Operation global collector config The operation collector is defined to receive stats from hosts. The VRNI and WAVE_FRONT collector type can be defined to collect the metric data. The WAVE_FRONT collector type can only be used in VMC mode.	array of GlobalCollectorConfig (Abstract type: pass one of the following concrete types) VrniGlobalCollector WaveFrontGlobalCollector
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 GlobalConfig	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly
uplink_mtu_threshold	Upper threshold for MTU on physical and logical uplinks This value defines the upper threshold for the Maximum Transmission Unit (MTU) value that can be configured at a physical uplink level or a logical routing uplink level in a NSX domain. All Uplink profiles validate against this value so that the MTU specified in an Uplink profile does not exceed this global upper threshold. Similarly, when this value is modified, the new value must be greater than or equal to any existing Uplink profile's MTU.	int	Default: "9000"
vdr_mac	MAC address of the Virtual Distributed Router (VDR) port This is the global default MAC address for all VDRs in all transport nodes in a NSX system. It can be changed only when there is no transport node in the NSX system. This value cannot be same as vdr_mac_nested. When the property "allow_changing_vdr_mac_in_use" is false, it can not be changed if the current VDR MAC is being used by any transport node. A transport node uses this VDR MAC if any host switch in the node is in OVERLAY transport zone(s) but none of the transport zone(s) has "nested_nsx" property being true.	MACAddress	Default: "02:50:56:56:44:52"
vdr_mac_nested	The MAC address of the Virtual Distributed Router (VDR) port in a nested NSX environment. This is the global default MAC address for all VDRs in all transport nodes in a NSX system nested in another NSX system. It can be changed only when there is no transport node in the NSX system. All transport zones in such a nested NSX system will have the "nested_nsx" property being true so that all transport nodes will use this MAC for the VDR ports to avoid conflict with the VDR MAC in the outer NSX system. When the property "allow_changing_vdr_mac_in_use" is false, it can not be changed if the current VDR MAC is being used by any transport node in a nested NSX environment. A transport node uses this VDR MAC if any host switch in the node is in an OVERLAY transport zone whose "nested_nsx" property is true.	MACAddress	Default: "02:50:56:56:44:53"

GlobalIdsSignature (schema)

Global IDS signature

Global IDS signature.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
action	Global IDS signature's action It denotes the global action of a IDS Signature. This will take precedence over IDS signature's action.	string	Enum: ALERT, DROP, REJECT
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
enable	Flag to Enable/Disable a IDS Signature globally. Flag through which user can Enable/Disable a Signature at Global Level.	boolean	Default: "True"
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 GlobalIdsSignature	string
signature_id	Signature ID Represents the Signature's id.	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

GlobalManager (schema)

Global Manager

Global Manager.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
connection_info	Connection information To create a standby GM, the connection information (username, password, and API thumbprint) for at least one NSX manager node in the remote site must be provided. Once the GM has been successfully onboarded, the connection_info is discarded and authentication to the standby GM occurs using an X.509 client certificate.	array of SiteNodeConnectionInfo	Maximum items: 3
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
fail_if_rtt_exceeded	Fail onboarding if maximum RTT exceeded Fail onboarding if maximum RTT exceeded.	boolean	Default: "True"
federation_id	Global manager federation UUID Internally generated UUID to the federation of Global Manager.	string	Readonly
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
maximum_rtt	Maximum acceptable packet round trip time (RTT) If provided and fail_if_rtt_exceeded is true, onboarding of the site will fail if measured RTT is greater than this value.	integer	Minimum: 0 Maximum: 1000 Default: "250"
mode	Mode of the global manager There can be at most one ACTIVE global manager and one STANDBY global manager. In order to add a STANDBY manager, there must be an ACTIVE manager defined.	string	Required Enum: ACTIVE, STANDBY
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 GlobalManager	string
site_id	UUID of the site where Global manager is running UUID of the site where Global manager is running. This is the Site Manager generated UUID for every NSX deployment.	string	Readonly
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

GlobalManagerConfig (schema)

Global Manager configuration

This configuration is distributed to all Sites participating in federation.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 GlobalManagerConfig	string
rtep_config	Global Manager federation RTEP configuration Global Manager federation RTEP configuration. This configuration is distributed to all Sites participating in federation.	GmRtepConfig
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

GlobalManagerListRequestParameters (schema)

Site List Request Parameters

Site 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
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

GlobalManagerListResult (schema)

Paged Collection of Global Managers

Paged Collection of Global Managers.

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Global Manager List Result Global Manager List Result.	array of GlobalManager	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

GlobalManagerSwitchOverRequestParameter (schema)

Parameter to force switchover

Parameter to force switch over from Standby to Active.

Name	Description	Type	Notes
force	Indciates force switchover to Active If true indicates that user requested make standby Global Manager as active ignoring the state of current active Global Manager. Typically, recommended to use when active Global Manager is failed or not reachable.	boolean

GlobalRestoreStatus (schema)

Overall restore process status

Name	Description	Type	Notes
description	A description of the restore status	string	Required Readonly
value	Global rolled-up restore status value	string	Required Readonly Enum: INITIAL, SUCCESS, FAILED, RUNNING, SUSPENDED_BY_USER, SUSPENDED_FOR_USER_ACTION, SUSPENDED, ABORTED

GmFederationSiteConfig (schema)

Federation configuration for the site

Additional configuration required for federation at Site.

Name	Description	Type	Notes
transit_subnet	Transit subnet in CIDR format IP Addresses to be allocated for transit segment when the gateway is stretched. Note that Global Manager will carve out the IP Pool for each site to be used for edge nodes when gateway is stretched based on the user provided subnet and maximum number of edge nodes allowed per site.	string

GmNodeStatus (schema)

Represents the Global Manager node switchover status

Name	Description	Type	Notes
end_time	End time of the switchover operation	integer
errors	Errors if any	array of string
node_id	UUID of the Global Manager node	string
start_time	Start time of the switchover operation	integer
status	Status of switchover operation	string	Enum: IN_PROGRESS, COMPLETED, FAILED
warnings	Errors if any	array of string

GmOperationalState (schema)

Represents the operational state of Global Manager

Represents the switchover operational state of Global Manager. Offers information
about the current switchover operation including status from each Global Manager
node and the errors if any.

Name	Description	Type	Notes
consolidated_progress	Consolidated status of the current operation	string	Enum: IN_PROGRESS, COMPLETED, FAILED
end_time	End time of the switchover operation	integer
errors	Errors if any	array of string
node_statuses	Switchover status from each NSX Global Manager appliance node	array of GmNodeStatus
site_manager_ref	Timestamp reference for the change provided by SiteManager	integer
start_time	Start time of the switchover operation	integer
status	The current switchover operation requested.	string	Required Enum: NONE, ACTIVE, STANDBY, SWITCHING_TO_ACTIVE, SWITCHING_TO_STANDBY, DECOMMISSIONED
warnings	Errors if any	array of string

GmRtepConfig (schema)

Global Manager federation RTEP configuration

Global Manager federation RTEP configuration. This configuration is distributed
to all Sites participating in federation.

Name	Description	Type	Notes
ibgp_password	Password for IBGP sessions between federated sites Password to authenticate IBGP session between remote tunnel endpoints created on federated sites. This is applied to inter-site underlay IBGP neighbors created over remote tunnel endpoints on all sites. Empty string ("") clears existing password.	string	Maximum length: 20

GraphConfiguration (schema)

Graph Configuration

Represents configuration of a graph widget

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
axes	Axes of a graph	Axes
datasources	Array of Datasource Instances with their relative urls The 'datasources' represent the sources from which data will be fetched. Currently, only NSX-API is supported as a 'default' datasource. An example of specifying 'default' datasource along with the urls to fetch data from is given at 'example_request' section of 'CreateWidgetConfiguration' API.	array of Datasource	Minimum items: 0
default_filter_value	Default filter value to be passed to datasources Default filter values to be passed to datasources. This will be used when the report is requested without filter values.	array of DefaultFilterValue
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Widget Title Title of the widget. If display_name is omitted, the widget will be shown without a title.	string	Maximum length: 255
display_x_value	Show or hide the value of a point on X axis If true, value of a point is shown as label on X axis. If false, value of point is not shown as label on X axis. false can be useful in situations where there are too many points and showing the X value as label can clutter the X axis.	boolean	Default: "False"
drilldown_id	Id of drilldown widget Id of drilldown widget, if any. Id should be a valid id of an existing widget. A widget is considered as drilldown widget when it is associated with any other widget and provides more detailed information about any data item from the parent widget.	string	Maximum length: 255
feature_set	Features required to view the widget Features required to view the widget.	FeatureSet
filter	Id of filter widget for subscription Id of filter widget for subscription, if any. Id should be a valid id of an existing filter widget. Filter widget should be from the same view. Datasource URLs should have placeholder values equal to filter alias to accept the filter value on filter change.	string
filter_value_required	Flag to indicate if filter value is necessary Flag to indicate that widget will continue to work without filter value. If this flag is set to false then default_filter_value is manadatory.	boolean	Default: "True"
footer		Footer
graphs	Graphs	array of GraphDefinition	Required Minimum items: 1
icons	Icons Icons to be applied at dashboard for widgets and UI elements.	array of Icon
id	Unique identifier of this resource	string	Sortable
is_drilldown	Set as a drilldown widget Set to true if this widget should be used as a drilldown.	boolean	Default: "False"
legend	Legend for the widget Legend to be displayed. If legend is not needed, do not include it.	Legend
navigation	Navigation to a specified UI page Hyperlink of the specified UI page that provides details.	string
resource_type	Must be set to the value GraphConfiguration	string	Required Readonly Enum: LabelValueConfiguration, DonutConfiguration, MultiWidgetConfiguration, ContainerConfiguration, StatsConfiguration, GridConfiguration, GraphConfiguration, CustomWidgetConfiguration, DropdownFilterWidgetConfiguration Maximum length: 255
shared	Visiblity of widgets to other users Please use the property 'shared' of View instead of this. The widgets of a shared view are visible to other users.	boolean	Deprecated
span	Horizontal span Represents the horizontal span of the widget / container.	int	Minimum: 1 Maximum: 12
sub_type	Subtype of a graph Describes the the type of graph. LINE_GRAPH shows a line graph chart BAR_GRAPH shows a simple bar graph chart STACKED_BAR_GRAPH shows a stacked bar graph chart	string	Enum: LINE_GRAPH, BAR_GRAPH, STACKED_BAR_GRAPH Default: "BAR_GRAPH"
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
weight	Weightage or placement of the widget or container Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details.	int	Deprecated
x_value_type	x value type x value type.	string	Enum: string, number, date Default: "string"

GraphDefinition (schema)

Definition of a graph

Defines a graph

Name	Description	Type	Notes
id	Identifier of graph Identifier of graph. It can be used to differentiate multiple graph series present in GraphWidgetConfiguration.	string
label	Label of a graph Describes the graph. It labels the entities of graph. If the label is not provided then it is not shown for a graph. For example, for a single graph, the title of widget can describe the graph and a label may not be necessary to be shown.	Label
point_definition	Definition for points of a graph Defines the points of a graph.	PointDefinition	Required
render_configuration	Render Configuration Additional rendering or conditional evaluation of the field values to be performed, if any.	array of RenderConfiguration	Minimum items: 0

GridConfiguration (schema)

Grid Configuration

Represents configuration of a Grid or Table widget.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
columns	Columns Array of columns of a Grid widget	array of ColumnItem	Required
datasources	Array of Datasource Instances with their relative urls The 'datasources' represent the sources from which data will be fetched. Currently, only NSX-API is supported as a 'default' datasource. An example of specifying 'default' datasource along with the urls to fetch data from is given at 'example_request' section of 'CreateWidgetConfiguration' API.	array of Datasource	Minimum items: 0
default_filter_value	Default filter value to be passed to datasources Default filter values to be passed to datasources. This will be used when the report is requested without filter values.	array of DefaultFilterValue
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Widget Title Title of the widget. If display_name is omitted, the widget will be shown without a title.	string	Maximum length: 255
drilldown_id	Id of drilldown widget Id of drilldown widget, if any. Id should be a valid id of an existing widget. A widget is considered as drilldown widget when it is associated with any other widget and provides more detailed information about any data item from the parent widget.	string	Maximum length: 255
feature_set	Features required to view the widget Features required to view the widget.	FeatureSet
filter	Id of filter widget for subscription Id of filter widget for subscription, if any. Id should be a valid id of an existing filter widget. Filter widget should be from the same view. Datasource URLs should have placeholder values equal to filter alias to accept the filter value on filter change.	string
filter_value_required	Flag to indicate if filter value is necessary Flag to indicate that widget will continue to work without filter value. If this flag is set to false then default_filter_value is manadatory.	boolean	Default: "True"
footer		Footer
icons	Icons Icons to be applied at dashboard for widgets and UI elements.	array of Icon
id	Unique identifier of this resource	string	Sortable
is_drilldown	Set as a drilldown widget Set to true if this widget should be used as a drilldown.	boolean	Default: "False"
legend	Legend for the widget Legend to be displayed. If legend is not needed, do not include it.	Legend
page_size	Page Size Number of records per page. page_size will be effective only when the urls provided in the datasource support paging.	int	Default: "30"
resource_type	Must be set to the value GridConfiguration	string	Required Readonly Enum: LabelValueConfiguration, DonutConfiguration, MultiWidgetConfiguration, ContainerConfiguration, StatsConfiguration, GridConfiguration, GraphConfiguration, CustomWidgetConfiguration, DropdownFilterWidgetConfiguration Maximum length: 255
row_list_fields	List of fields from which rows are formed Rows of grid or table are formed from the list of objects returned by a row list field.	array of RowListField	Required Minimum items: 1
shared	Visiblity of widgets to other users Please use the property 'shared' of View instead of this. The widgets of a shared view are visible to other users.	boolean	Deprecated
span	Horizontal span Represents the horizontal span of the widget / container.	int	Minimum: 1 Maximum: 12
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
weight	Weightage or placement of the widget or container Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details.	int	Deprecated

Group (schema)

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.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource (Abstract type: pass one of the following concrete types) ChildDnsSecurityProfileBindingMap ChildGroupDiscoveryProfileBindingMap ChildGroupMonitoringProfileBindingMap ChildPolicyFirewallFloodProtectionProfileBindingMap ChildPolicyFirewallSessionTimerProfileBindingMap
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 The expression list must follow below criteria: 1. A non-empty expression list, must be of odd size. In a list, with indices starting from 0, all non-conjunction expressions must be at even indices, separated by a conjunction expression at odd indices. 2. The total of ConditionExpression and NestedExpression in a list should not exceed 5. 3. The total of IPAddressExpression, MACAddressExpression, external IDs in an ExternalIDExpression and paths in a PathExpression must not exceed 500. 4. Each expression must be a valid Expression. See the definition of the Expression type for more information.	array of Expression (Abstract type: pass one of the following concrete types) Condition ConjunctionOperator ExternalIDExpression IPAddressExpression IdentityGroupExpression MACAddressExpression NestedExpression PathExpression
extended_expression	Extended Expression Extended Expression allows additional higher level context to be specified for grouping criteria. (e.g. user AD group) This field allow users to specified user context as the source of a firewall rule for IDFW feature. Current version only support a single IdentityGroupExpression. In the future, this might expand to support other conjunction and non-conjunction expression. The extended expression list must follow below criteria: 1. Contains a single IdentityGroupExpression. No conjunction expression is supported. 2. No other non-conjunction expression is supported, except for IdentityGroupExpression. 3. Each expression must be a valid Expression. See the definition of the Expression type for more information. 4. Extended expression are implicitly AND with expression. 5. No nesting can be supported if this value is used. 6. If a Group is using extended expression, this group must be the only member in the source field of an communication map.	array of Expression (Abstract type: pass one of the following concrete types) Condition ConjunctionOperator ExternalIDExpression IPAddressExpression IdentityGroupExpression MACAddressExpression NestedExpression PathExpression	Maximum items: 1
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
reference	Indicates if the group is a reference. If true, indicates that this is a remote reference group. Such group will have span different from the its parent domain. Default value is false.	boolean	Readonly Default: "False"
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: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

GroupDeleteRequestParameters (schema) (Deprecated)

Group delete request parameters

Name	Description	Type	Notes
fail_if_subtree_exists	Do not delete if the group subtree has any entities Check if the group sub-tree has any entities. These primarily include the binding maps that point to various profiles. If this flag is passed as true, the group delete fails if any binding maps exist in the group sub-tree. By default, this flag is false, which means that the group is deleted along with the group sub-tree.	boolean	Default: "False"
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"

GroupDiscoveryProfileBindingMap (schema)

Map for binding group with discovery profile

This entity will be used to establish association between discovery profile and
Group. With this entity, user can specify intent for applying discovery profile
profile to particular 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.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
profile_path	Profile Path PolicyPath of associated Profile	string	Required
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value GroupDiscoveryProfileBindingMap	string
sequence_number	Sequence number group discovery profile Binding Map Sequence number used to resolve conflicts betweeen two profiles applied on the same group. Lower sequence number takes higher precedence. Two binding maps applied to the same profile must have the same sequence number. User defined sequence numbers range from 1 through 100,000. System defined sequence numbers range from 100,001 through 200,000.	integer	Minimum: 1 Maximum: 100000
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

GroupDiscoveryProfileBindingMapListRequestParameters (schema)

Group Discovery Profile Binding Map 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
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

GroupDiscoveryProfileBindingMapListResult (schema)

Paged collection of Group Discovery Profile Binding 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	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Group Discovery Profile Binding Map List Results	array of GroupDiscoveryProfileBindingMap
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

GroupListRequestParameters (schema)

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
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
member_types	Comma Seperated Member types Optionally, specify valid member types as request parameter to filter NSGroups.	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)

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	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Group list results	array of Group	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

GroupMemberActionParameters (schema)

Request Parameters for Group members

Request Parameter to either add or remove the Group members.

Name	Description	Type	Notes
action	Add or Remove group members. Action parameter determines whether to add or remove the group members.	string	Required Enum: add, remove

GroupMemberList (schema)

Members to add or remove for a Group.

List of same type members to either add or remove from a group.

Name	Description	Type	Notes
members	Groups members collection This array contains group members of similar types.	array of string	Required Minimum items: 1 Maximum items: 4000

GroupMemberTagsList (schema)

Group tags list for a particular member type

Collection of tags used in a policy group for a particular member type

Name	Description	Type	Notes
member_type	Member type for which we will list the tags	string	Required
tags	List of tags for the member type	array of string	Required

GroupMemberType (schema)

Valid Group member type

Name	Description	Type	Notes
GroupMemberType	Valid Group member type	string	Enum: VirtualMachine, VirtualNetworkInterface, SegmentPort, Segment, CloudNativeServiceInstance, IPAddress, MACAddress, IPSet, IdentityGroup, PhysicalServer

GroupMemberTypeListResult (schema)

Name	Description	Type	Notes
result_count	Count of the member types in the results array	integer	Required Readonly
results	Collection of member types for the given Group	array of GroupMemberType	Required

GroupMonitoringProfileBindingMap (schema)

Group Monitoring Profile binding map

This entity will be used to establish association between monitoring
profile and Group. Using this entity, you can specify intent for applying
monitoring profile to particular Group. Group with membership criteria vm
only supported as source group. Port mirroring is only supported on group
with five vms.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
ipfix_dfw_profile_path	IPFIX DFW Profile Path PolicyPath of associated IPFIX DFW Profile	string
ipfix_l2_profile_path	IPFIX L2 Profile Path PolicyPath of associated IPFIX L2 Profile	string
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
port_mirroring_profile_path	Port Mirroring Profile Path PolicyPath of associated Port Mirroring Profile	string
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value GroupMonitoringProfileBindingMap	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

GroupMonitoringProfileBindingMapListRequestParameters (schema)

Group Monitoring Profile Binding Map 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
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

GroupMonitoringProfileBindingMapListResult (schema)

Paged collection of Group Monitoring Profile Binding Maps

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Group Monitoring Profile Binding Map list results	array of GroupMonitoringProfileBindingMap	Required
sort_ascending	If true, results are sorted in ascending order	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 in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

GroupTagsList (schema)

Group tags list listed per member type

Collection of tags used in a policy group listed per member type

Name	Description	Type	Notes
results	Collection of tags used in a policy group listed per member type	array of GroupMemberTagsList	Required

GuestInfo (schema)

Guest virtual machine details

Guest virtual machine details include OS name and computer name of guest VM.

Name	Description	Type	Notes
computer_name	Computer name Computer name of guest virtual machine, which is set inside guest OS. Currently this is supported for guests on ESXi that have VMware Tools installed.	string	Readonly
os_name	OS name OS name of guest virtual machine. Currently this is supported for guests on ESXi that have VMware Tools installed.	string	Readonly

Header (schema)

Widget Header

Header of a widget that provides additional information. This will be shown at the container level. It includes details as label value pairs.

Name	Description	Type	Notes
condition	Expression for evaluating condition If the condition is met then the header will be applied. Examples of expression syntax are provided under 'example_request' section of 'CreateWidgetConfiguration' API.	string	Maximum length: 1024
content_alignment	alignment for labelvalue pair Alignment of header labels.	string	Enum: LEFT, RIGHT Default: "RIGHT"
sub_headers	Rows An array of label-value properties.	array of PropertyItem	Minimum items: 0

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
current_version_node_summary	Mapping of current versions of nodes and counts of nodes at the respective versions.	NodeSummaryList	Readonly
details	Details about the upgrade status	string	Readonly
node_count_at_target_version	Count of nodes at target component version Number of nodes of the type and at the component version	int	Readonly
percent_complete	Indicator of upgrade progress in percentage	number	Required Readonly
pre_upgrade_status	Pre-upgrade status of the component-type	UpgradeChecksExecutionStatus	Readonly
status	Upgrade status of component	string	Required Readonly Enum: SUCCESS, FAILED, IN_PROGRESS, NOT_STARTED, PAUSING, PAUSED
target_component_version	Target component version	string	Readonly

HostnameOrIPv4Address (schema)

Hostname or IPv4 address

Name	Description	Type	Notes
HostnameOrIPv4Address	Hostname or IPv4 address	string

HostnameOrIPv4AddressOrEmptyString (schema)

Hostname or IPv4 address

Name	Description	Type	Notes
HostnameOrIPv4AddressOrEmptyString	Hostname or IPv4 address	string	Maximum length: 255 Pattern: "^(?=.{1,255}$)[0-9A-Za-z](?:(?:[0-9A-Za-z]|-){0,61}[0-9A-Za-z])?(?:\.[0-9A-Za-z](?:(?:[0-9A-Za-z]|-){0,61}[0-9A-Za-z])?)*\.?$|^$"

HttpPolicyLbMonitorProfile (schema)

PolicyLbMonitorProfile for active health checks over HTTP

Active healthchecks are disabled by default and can be enabled for a
server pool by binding a health monitor to the Group through the PolicyLbRule
object. This represents active health monitoring over HTTP.
Active healthchecks are initiated periodically, at a configurable
interval, to each member of the Group. Only if a healthcheck fails
consecutively for a specified number of times (fall_count) to a member will
the member status be marked DOWN. Once a member is DOWN, a specified
number of consecutive successful healthchecks (rise_count) will bring the
member back to UP state. After a healthcheck is initiated, if it does not
complete within a certain period, then also the healthcheck is considered
to be unsuccessful.
Completing a healthcheck within timeout means establishing a connection
(TCP or SSL), if applicable, sending the request and receiving the
response, all within the configured timeout.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
fall_count	Monitor fall count for active healthchecks Only if a healthcheck fails consecutively for a specified number of times, given with fall_count, to a member will the member status be marked DOWN.	integer	Default: "3"
id	Unique identifier of this resource	string	Sortable
interval	Monitor interval in seconds for active healthchecks Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group.	integer	Default: "5"
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
monitor_port	Monitor port for active healthchecks Typically, monitors perform healthchecks to Group members using the member IP address and pool_port. However, in some cases, customers prefer to run healthchecks against a different port than the pool member port which handles actual application traffic. In such cases, the port to run healthchecks against can be specified in the monitor_port value.	int	Minimum: 0 Maximum: 65535
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 HttpPolicyLbMonitorProfile	string	Required Enum: TcpPolicyLbMonitorProfile, UdpPolicyLbMonitorProfile, IcmpPolicyLbMonitorProfile, HttpPolicyLbMonitorProfile, HttpsPolicyLbMonitorProfile
rise_count	Monitor rise count for active healthchecks Once a member is DOWN, a specified number of consecutive successful healthchecks specified by rise_count will bring the member back to UP state.	integer	Default: "3"
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
timeout	Monitor timeout in seconds for active healthchecks Timeout specified in seconds. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.	integer	Default: "15"
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly
url	Customized HTTP request url for active health checks For HTTP active healthchecks, the HTTP request url sent can be customized and can include query parameters.	string	Default: "/"

HttpPolicyLbVirtualServer (schema)

PolicyLbVirtualServer handling connections over HTTP

Virtual server acts as a facade to an application, receives
all client connections over HTTP
and distributes them among the backend servers.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
access_log_enabled	Access log enabled setting If access log is enabled, all HTTP requests sent to an L7 virtual server are logged to the access log file. Both successful requests (backend server returns 2xx) and unsuccessful requests (backend server returns 4xx or 5xx) are logged to access log, if enabled.	boolean	Default: "False"
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
insert_client_ip_header	Relative path of this object Backend web servers typically log each request they handle along with the requesting client IP address. These logs are used for debugging, analytics and other such purposes. If the deployment topology requires enabling SNAT on the load balancer, then server will see the client as the SNAT IP which defeats the purpose of logging. To work around this issue, load balancer can be configured to insert XFF HTTP header with the original client IP address. Backend servers can then be configured to log the IP address in XFF header instead of the source IP address of the connection. If XFF header is not present in the incoming request, load balancer inserts a new XFF header with the client IP address.	boolean	Default: "False"
ip_address	IP address of the PolicyLbVirtualServer Configures the IP address of the PolicyLbVirtualServer where it receives all client connections and distributes them among the backend servers.	IPAddress	Required
lb_persistence_profile	Persistence Profile used by PolicyLbVirtualServer Path to optional object that enables persistence on a virtual server allowing related client connections to be sent to the same backend server. Persistence is disabled by default.	string
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
ports	Virtual server port number(s) or port range(s) Ports contains a list of at least one port or port range such as "80", "1234-1236". Each port element in the list should be a single port or a single port range.	array of PortElement	Required
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value HttpPolicyLbVirtualServer	string	Required Enum: TcpPolicyLbVirtualServer, UdpPolicyLbVirtualServer, HttpPolicyLbVirtualServer, HttpsPolicyLbVirtualServer, CustomPolicyLbVirtualServer
router_path	Path to router type object for PolicyLbVirtualServer Path to router type object that PolicyLbVirtualServer connects to. The only supported router object is Network.	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
traffic_source		string
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

HttpProtocol (schema)

Name	Description	Type	Notes
authentication_scheme	Scheme to authenticate if required	BasicAuthenticationScheme
name	Must be set to the value HttpProtocol	string	Required Enum: http, https, scp, sftp

HttpRequestMethodType (schema)

http monitor method

Name	Description	Type	Notes
HttpRequestMethodType	http monitor method	string	Enum: GET, OPTIONS, POST, HEAD, PUT

HttpRequestVersionType (schema)

http request version

Name	Description	Type	Notes
HttpRequestVersionType	http request version	string	Enum: HTTP_VERSION_1_0, HTTP_VERSION_1_1

HttpServiceProperties (schema)

HTTP Service properties

Name	Description	Type	Notes
basic_authentication_enabled	Enable or disable basic authentication Identifies whether basic authentication is enabled or disabled in API calls.	boolean	Default: "True"
certificate		Certificate	Required Readonly
cipher_suites	Cipher suites used to secure contents of connection	array of CipherSuite	Minimum items: 1
client_api_concurrency_limit	Client API rate limit in calls The maximum number of concurrent API requests that will be serviced for a given authenticated client. If the number of API requests being processed exceeds this limit, new API requests will be refused and a 503 Service Unavailable response will be returned to the client. To disable API concurrency limiting, set this value to 0.	integer	Minimum: 0 Default: "40"
client_api_rate_limit	Client API rate limit in calls per second The maximum number of API requests that will be serviced per second for a given authenticated client. If more API requests are received than can be serviced, a 429 Too Many Requests HTTP response will be returned. To disable API rate limiting, set this value to 0.	integer	Minimum: 0 Default: "100"
connection_timeout	NSX connection timeout, set to 0 to configure no timeout	integer	Minimum: 0 Maximum: 2147483647
cookie_based_authentication_enabled	Enable or disable cookie-based authentication Identifies whether cookie-based authentication is enabled or disabled in API calls. When cookie-based authentication is disabled, new sessions cannot be created via /api/session/create.	boolean	Default: "True"
global_api_concurrency_limit	Global API rate limit in calls The maximum number of concurrent API requests that will be serviced. If the number of API requests being processed exceeds this limit, new API requests will be refused and a 503 Service Unavailable response will be returned to the client. To disable API concurrency limiting, set this value to 0.	integer	Minimum: 0 Default: "100"
logging_level	Service logging level	string	Enum: OFF, FATAL, ERROR, WARN, INFO, DEBUG, TRACE Default: "INFO"
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

HttpsPolicyLbMonitorProfile (schema)

PolicyLbMonitorProfile for active health checks over HTTPS

Active healthchecks are disabled by default and can be enabled for a
server pool by binding a health monitor to the Group through the PolicyLbRule
object. This represents active health monitoring over HTTPS. Active
healthchecks are initiated periodically, at a configurable interval, to
each member of the Group. Only if a healthcheck fails consecutively for a
specified number of times (fall_count) to a member will the member status
be marked DOWN. Once a member is DOWN, a specified number of consecutive
successful healthchecks (rise_count) will bring the member back to UP
state. After a healthcheck is initiated, if it does not complete within a
certain period, then also the healthcheck is considered to be
unsuccessful. Completing a healthcheck within timeout means establishing
a connection (TCP or SSL), if applicable, sending the request and
receiving the response, all within the configured timeout.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
fall_count	Monitor fall count for active healthchecks Only if a healthcheck fails consecutively for a specified number of times, given with fall_count, to a member will the member status be marked DOWN.	integer	Default: "3"
id	Unique identifier of this resource	string	Sortable
interval	Monitor interval in seconds for active healthchecks Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group.	integer	Default: "5"
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
monitor_port	Monitor port for active healthchecks Typically, monitors perform healthchecks to Group members using the member IP address and pool_port. However, in some cases, customers prefer to run healthchecks against a different port than the pool member port which handles actual application traffic. In such cases, the port to run healthchecks against can be specified in the monitor_port value.	int	Minimum: 0 Maximum: 65535
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 HttpsPolicyLbMonitorProfile	string	Required Enum: TcpPolicyLbMonitorProfile, UdpPolicyLbMonitorProfile, IcmpPolicyLbMonitorProfile, HttpPolicyLbMonitorProfile, HttpsPolicyLbMonitorProfile
rise_count	Monitor rise count for active healthchecks Once a member is DOWN, a specified number of consecutive successful healthchecks specified by rise_count will bring the member back to UP state.	integer	Default: "3"
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
timeout	Monitor timeout in seconds for active healthchecks Timeout specified in seconds. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.	integer	Default: "15"
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly
url	Customized HTTP request url for active health checks For HTTP active healthchecks, the HTTP request url sent can be customized and can include query parameters.	string	Default: "/"

HttpsPolicyLbVirtualServer (schema)

PolicyLbVirtualServer handling connections over HTTPS

Virtual server acts as a facade to an application, receives all client
connections over HTTPS and distributes them among the backend servers.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
access_log_enabled	Access log enabled setting If access log is enabled, all HTTP requests sent to an L7 virtual server are logged to the access log file. Both successful requests (backend server returns 2xx) and unsuccessful requests (backend server returns 4xx or 5xx) are logged to access log, if enabled.	boolean	Default: "False"
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
client_ssl_certificate_ids	ssl certificates Client-side SSL profile binding allows multiple certificates, for different hostnames, to be bound to the same virtual server. The setting is used when load balancer acts as an SSL server and terminating the client SSL connection	array of string
client_ssl_settings	Security profile setting Security settings representing various security settings when the VirtualServer acts as an SSL server - BASE_SECURE_111317 - MODERATE_SECURE_111317 - HIGH_SECURE_111317	string	Enum: BASE_SECURE_111317, MODERATE_SECURE_111317, HIGH_SECURE_111317 Default: "HIGH_SECURE_111317"
default_client_ssl_certificate_id	ssl certificate The setting is used when load balancer acts as an SSL server and terminating the client SSL connection. A default certificate should be specified which will be used if the server does not host multiple hostnames on the same IP address or if the client does not support SNI extension.	string	Required
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	Sortable
insert_client_ip_header	Relative path of this object Backend web servers typically log each request they handle along with the requesting client IP address. These logs are used for debugging, analytics and other such purposes. If the deployment topology requires enabling SNAT on the load balancer, then server will see the client as the SNAT IP which defeats the purpose of logging. To work around this issue, load balancer can be configured to insert XFF HTTP header with the original client IP address. Backend servers can then be configured to log the IP address in XFF header instead of the source IP address of the connection. If XFF header is not present in the incoming request, load balancer inserts a new XFF header with the client IP address.	boolean	Default: "False"
ip_address	IP address of the PolicyLbVirtualServer Configures the IP address of the PolicyLbVirtualServer where it receives all client connections and distributes them among the backend servers.	IPAddress	Required
lb_persistence_profile	Persistence Profile used by PolicyLbVirtualServer Path to optional object that enables persistence on a virtual server allowing related client connections to be sent to the same backend server. Persistence is disabled by default.	string
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
ports	Virtual server port number(s) or port range(s) Ports contains a list of at least one port or port range such as "80", "1234-1236". Each port element in the list should be a single port or a single port range.	array of PortElement	Required
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value HttpsPolicyLbVirtualServer	string	Required Enum: TcpPolicyLbVirtualServer, UdpPolicyLbVirtualServer, HttpPolicyLbVirtualServer, HttpsPolicyLbVirtualServer, CustomPolicyLbVirtualServer
router_path	Path to router type object for PolicyLbVirtualServer Path to router type object that PolicyLbVirtualServer connects to. The only supported router object is Network.	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
traffic_source		string
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

HttpsProtocol (schema)

Name	Description	Type	Notes
authentication_scheme	Scheme to authenticate if required	BasicAuthenticationScheme
name	Must be set to the value HttpsProtocol	string	Required Enum: http, https, scp, sftp
sha256_thumbprint	SSL thumbprint of server	string	Required

ICMPTypeServiceEntry (schema)

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.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Minimum: 0 Maximum: 255
icmp_type	ICMP message type	integer	Minimum: 0 Maximum: 255
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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: IPProtocolServiceEntry, IGMPTypeServiceEntry, ICMPTypeServiceEntry, ALGTypeServiceEntry, L4PortSetServiceEntry, EtherTypeServiceEntry, NestedServiceServiceEntry
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

IGMPTypeServiceEntry (schema)

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.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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: IPProtocolServiceEntry, IGMPTypeServiceEntry, ICMPTypeServiceEntry, ALGTypeServiceEntry, L4PortSetServiceEntry, EtherTypeServiceEntry, NestedServiceServiceEntry
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

IPAddress (schema)

IPv4 or IPv6 address

Name	Description	Type	Notes
IPAddress	IPv4 or IPv6 address	string

IPAddressExpression (schema)

IP address expression node

Represents IP address expressions in the form of an array, to support addition of IP addresses in a group. Avoid creating groups with multiple IPAddressExpression. In future releases, group will be restricted to contain a single IPAddressExpression. To group IPAddresses, use nested groups instead of multiple IPAddressExpressions.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	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 Minimum items: 1 Maximum items: 4000
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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, ExternalIDExpression, PathExpression, IdentityGroupExpression
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

IPAddressGroupAssociationRequestParams (schema)

List request parameters containing ip address and enforcement point path

List request parameters containing ip address and enforcement point path

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
enforcement_point_path	String Path of the enforcement point The path of the enforcement point from which the list of groups needs to be fetched. Forward slashes must be escaped using %2F. If no enforcement point path is specified, the default enforcement point is considered	string
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
ip_address	IPAddress	string	Required
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

IPAddressList (schema)

IP Address collection.

Collection of IP Addresses.

Name	Description	Type	Notes
ip_addresses	Array of IP addresses The array contains IP addresses.	array of IPElement	Required Minimum items: 1 Maximum items: 4000

IPAddressPortPair (schema)

IP Address and Port information

IP Address and Port information

Name	Description	Type	Notes
ip_address	IPAddress for IPAddressPort combination The IPAddress to be combined with Port for defining specific access point.	IPAddress	Required
port	The port for IPAddressPort combination The port to be combined with IPAddress for defining a specific access point.	int	Minimum: 0 Maximum: 65535

IPCIDRBlock (schema)

IPv4 or IPv6 CIDR Block

Name	Description	Type	Notes
IPCIDRBlock	IPv4 or IPv6 CIDR Block	string

IPDiscoveryProfile (schema)

IP Discovery Profile

Using this profile to configure different options of IP Discovery

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
arp_nd_binding_timeout	ARP and ND cache timeout (in minutes) This property controls the ARP and ND cache timeout period. It is recommended that this property be greater than the ARP/ND cache timeout on the VM.	int	Minimum: 5 Maximum: 120 Default: "10"
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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
duplicate_ip_detection	Duplicate IP Dection Options Duplicate IP detection is used to determine if there is any IP conflict with any other port on the same logical switch. If a conflict is detected, then the IP is marked as a duplicate on the port where the IP was discovered last. The duplicate IP will not be added to the realized address binings for the port and hence will not be used in DFW rules or other security configurations for the port.rt.	DuplicateIPDetectionOptions
id	Unique identifier of this resource	string	Sortable
ip_v4_discovery_options	IPv4 Discovery options Indicates IPv4 Discovery options	IPv4DiscoveryOptions
ip_v6_discovery_options	IPv6 Discovery options Indicates IPv6 Discovery options	IPv6DiscoveryOptions
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 IPDiscoveryProfile	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
tofu_enabled	Is TOFU enabled or not Indicates whether "Trust on First Use(TOFU)" paradigm is enabled.	boolean	Default: "True"
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

IPDiscoveryProfileListRequestParameters (schema)

IP Discovery Profile request parameters

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

IPDiscoveryProfileListResult (schema)

Paged collection of IP Discovery Profiles

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	IP Discovery profile list results	array of IPDiscoveryProfile	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

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

IPElementList (schema)

List of 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
IPElementList	List of 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

IPFIXDFWCollector (schema)

IPFIX DFW Collector

IPFIX DFW data will be collected on collector
Host IP and Port address should be provided for collector.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
collector_ip_address	IP address IP address for the IPFIX DFW collector. IP addresses such as 0.0.0.0, 127.0.0.1, 255.255.255.255 are invalid.	IPAddress	Required
collector_port	Port Port for the IPFIX DFW collector.	int	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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 IPFIXDFWCollector	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

IPFIXDFWCollectorProfile (schema)

IPFIX DFW Collector Profile

IPFIX data for the NSX distributed firewall will be sent to the specified
IPFIX collectors.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
ipfix_dfw_collectors	IPFIX DFW Collectors. It accepts Multiple Collectors.	array of IPFIXDFWCollector	Required Minimum items: 1
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 IPFIXDFWCollectorProfile	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

IPFIXDFWCollectorProfileListRequestParameters (schema)

IPFIX DFW Collector Profile request parameters

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

IPFIXDFWCollectorProfileListResult (schema)

Paged Collection of IPFIX DFW Collector Profile

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	IPFIX DFW Collection Instances list results	array of IPFIXDFWCollectorProfile	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

IPFIXDFWProfile (schema)

IPFIX DFW Profile

IPFIX packets from source will be sent to IPFIX DFW collector.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
active_flow_export_timeout	Active timeout (Minutes) For long standing active flows, IPFIX records will be sent per timeout period in minutes.	int	Required Minimum: 1 Maximum: 60 Default: "1"
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
ipfix_dfw_collector_profile_path	IPFIX collector Paths Policy path for IPFIX collector profiles. IPFIX data from these logical segments will be sent to all specified IPFIX collectors.	string	Required
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
observation_domain_id	Observation domain ID An identifier that is unique to the exporting process and used to meter the flows.	int	Minimum: 0 Maximum: 65536 Default: "0"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
priority	Config Priority This priority field is used to resolve conflicts in Segment Ports which are covered by more than one IPFIX profiles. The IPFIX exporter will send records to Collectors in highest priority profile (lowest number) only.	int	Minimum: 0 Maximum: 32000 Default: "0"
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value IPFIXDFWProfile	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

IPFIXDFWProfileListRequestParameters (schema)

IPFIX DFW Profile request parameters

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

IPFIXDFWProfileListResult (schema)

Paged Collection of IPFIX DFW Profile

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	IPFIX DFW Profile list results	array of IPFIXDFWProfile	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

IPFIXL2Collector (schema)

IPFIX L2 Collector

IPFIX packets will be collected on collector.
IP and port address should be provided for collector.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
collector_ip_address	IP address IP address for the IPFIX L2 collector. IP addresses such as 0.0.0.0, 127.0.0.1, 255.255.255.255 are invalid.	IPAddress	Required
collector_port	Port Port number for the IPFIX L2 collector.	int	Minimum: 0 Maximum: 65535 Default: "4739"
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 IPFIXL2Collector	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

IPFIXL2CollectorProfile (schema)

IPFIX L2 Collector Profile

IPFIX L2 data will be collected on collectors.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
ipfix_l2_collectors	It accepts Multiple Collector objects. It accepts Multiple Collector objects.	array of IPFIXL2Collector	Required Minimum items: 1 Maximum items: 4
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 IPFIXL2CollectorProfile	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

IPFIXL2CollectorProfileListRequestParameters (schema)

IPFIX collector profile request parameters

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

IPFIXL2CollectorProfileListResult (schema)

Paged list of IPFIX collector profiles.

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	IPFIX collector Profile list results	array of IPFIXL2CollectorProfile	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

IPFIXL2Profile (schema)

IPFIX L2 Profile

IPFIX data from source logical segment, port, group will be forwarded to IPFIX
collector.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
active_timeout	Active timeout The time in seconds after a flow is expired even if more packets matching this flow are received by the cache.	int	Minimum: 60 Maximum: 3600 Default: "300"
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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
export_overlay_flow	Export overlay Flow This property controls whether overlay flow info is included in the sample result.	boolean	Default: "True"
id	Unique identifier of this resource	string	Sortable
idle_timeout	Idle timeout The time in seconds after a flow is expired if no more packets matching this flow are received by the cache.	int	Minimum: 60 Maximum: 3600 Default: "300"
ipfix_collector_profile_path	IPFIX collector Path Policy path for IPFIX collector profile. User can specify only one IPFIX collector.	string	Required
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
max_flows	Max flows The maximum number of flow entries in each exporter flow cache.	integer	Minimum: 0 Maximum: 4294967295 Default: "16384"
observation_domain_id	Observation domain ID An identifier that is unique to the exporting process and used to meter the flows.	integer	Minimum: 0 Maximum: 4294967295 Default: "0"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
packet_sample_probability	Packet sample probability The probability in percentage that a packet is sampled, in range 0-100. The probability is equal for every packet.	number	Required Minimum: 0 Maximum: 100 Default: "0.1"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
priority	Config Priority This priority field is used to resolve conflicts in Segment Ports which are covered by more than one IPFIX profiles. The IPFIX exporter will send records to Collectors in highest priority profile (lowest number) only.	int	Minimum: 0 Maximum: 32000 Default: "0"
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value IPFIXL2Profile	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

IPFIXL2ProfileListRequestParameters (schema)

IPFIX L2 Profile request parameters

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

IPFIXL2ProfileListResult (schema)

Paged Collection of IPFIX L2 Profile

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	IPFIX L2 Profile list results	array of IPFIXL2Profile	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

IPInfo (schema)

Name	Description	Type	Notes
ip_addresses	IPv4 Addresses	array of IPv4Address	Required Minimum items: 1 Maximum items: 1
prefix_length	Subnet Prefix Length	integer	Required Minimum: 1 Maximum: 32

IPProtocolServiceEntry (schema)

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.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
protocol_number		integer	Required Minimum: 0 Maximum: 255
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: IPProtocolServiceEntry, IGMPTypeServiceEntry, ICMPTypeServiceEntry, ALGTypeServiceEntry, L4PortSetServiceEntry, EtherTypeServiceEntry, NestedServiceServiceEntry
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

IPSecDigestAlgorithm (schema)

Digest Algorithms used in IPSec tunnel establishment

The IPSecDigestAlgorithms are used to verify message
integrity during IPSec VPN tunnel establishment.
SHA1 produces 160 bits hash and SHA2_XXX produces
XXX bit hash.

Name	Description	Type	Notes
IPSecDigestAlgorithm	Digest Algorithms used in IPSec tunnel establishment The IPSecDigestAlgorithms are used to verify message integrity during IPSec VPN tunnel establishment. SHA1 produces 160 bits hash and SHA2_XXX produces XXX bit hash.	string	Enum: SHA1, SHA2_256, SHA2_384, SHA2_512

IPSecEncryptionAlgorithm (schema)

Encryption algorithm used in IPSec tunnel

IPSecEncryptionAlgorithms are used to ensure confidentiality
of the messages exchanged during Tunnel negotiations. AES
stands for Advanced Encryption Standards. AES_128 uses 128-bit
keys whereas AES_256 uses 256-bit keys for encryption and
decryption. AES_GCM stands for Advanced Encryption Standard(AES)
in Galois/Counter Mode (GCM) and is used to provide both
confidentiality and data origin authentication.
NO_ENCRYPTION_AUTH_AES_GMAC_* enables authentication on input
data without encyption. Digest algorithm should be empty for this
option.

Name	Description	Type	Notes
IPSecEncryptionAlgorithm	Encryption algorithm used in IPSec tunnel IPSecEncryptionAlgorithms are used to ensure confidentiality of the messages exchanged during Tunnel negotiations. AES stands for Advanced Encryption Standards. AES_128 uses 128-bit keys whereas AES_256 uses 256-bit keys for encryption and decryption. AES_GCM stands for Advanced Encryption Standard(AES) in Galois/Counter Mode (GCM) and is used to provide both confidentiality and data origin authentication. NO_ENCRYPTION_AUTH_AES_GMAC_* enables authentication on input data without encyption. Digest algorithm should be empty for this option.	string	Enum: AES_128, AES_256, AES_GCM_128, AES_GCM_192, AES_GCM_256, NO_ENCRYPTION_AUTH_AES_GMAC_128, NO_ENCRYPTION_AUTH_AES_GMAC_192, NO_ENCRYPTION_AUTH_AES_GMAC_256, NO_ENCRYPTION

IPSecVpnDpdProfile (schema)

Dead peer detection (DPD) profile

Dead peer detection (DPD) is a method that allows detection of unreachable internet key excahnge (IKE) peers. Any changes affects all IPSec VPN sessions consuming this profile.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
dpd_probe_interval	DPD Probe Interval DPD probe interval defines an interval for DPD probes (in seconds). - When the DPD probe mode is periodic, this interval is the number of seconds between DPD messages. - When the DPD probe mode is on-demand, this interval is the number of seconds during which traffic is not received from the peer before DPD retry messages are sent if there is IPSec traffic to send. For PERIODIC Mode: Minimum: 3 Maximum: 360 Default: 60 For ON_DEMAND Mode: Minimum: 1 Maximum: 10 Default: 3	integer
dpd_probe_mode	DPD Probe Mode DPD probe mode is used to query the liveliness of the peer. Two modes are possible: - PERIODIC: is used to query the liveliness of the peer at regular intervals (dpd_probe_interval). It does not take into consideration traffic coming from the peer. The benefit of this mode over the on-demand mode is earlier detection of dead peers. However, use of periodic DPD incurs extra overhead. When communicating to large numbers of peers, please consider using on-demand DPD instead. - ON_DEMAND: is used to query the liveliness of the peer by instructing the local endpoint to send DPD message to a peer if there is traffic to send to the peer AND the peer was idle for dpd_probe_interval seconds (i.e. there was no traffic from the peer for dpd_probe_interval seconds).	string	Enum: PERIODIC, ON_DEMAND Default: "PERIODIC"
enabled	Enable dead peer detection (DPD) If true, enable dead peer detection.	boolean	Default: "True"
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 IPSecVpnDpdProfile	string
retry_count	Retry Count Maximum number of DPD messages' retry attempts. This value is applicable for both dpd probe modes, periodic and on-demand.	integer	Minimum: 1 Maximum: 100 Default: "10"
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

IPSecVpnIkeProfile (schema)

Internet key exchange (IKE) profile

IKE Profile is a reusable profile that captures IKE phase one negotiation parameters. Any changes affects all IPSec VPN sessions consuming this profile.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
description	Description of this resource	string	Maximum length: 1024 Sortable
dh_groups	DH group Diffie-Hellman group to be used if PFS is enabled. Default is GROUP14.	array of DhGroup
digest_algorithms	Algorithm for message hash Algorithm to be used for message digest during Internet Key Exchange(IKE) negotiation. Default is SHA2_256.	array of IkeDigestAlgorithm
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
encryption_algorithms	Encryption algorithm for IKE Encryption algorithm is used during Internet Key Exchange(IKE) negotiation. Default is AES_128.	array of IkeEncryptionAlgorithm
id	Unique identifier of this resource	string	Sortable
ike_version	IKE version IKE protocol version to be used. IKE-Flex will initiate IKE-V2 and responds to both IKE-V1 and IKE-V2.	string	Enum: IKE_V1, IKE_V2, IKE_FLEX Default: "IKE_V2"
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 IPSecVpnIkeProfile	string
sa_life_time	Security association (SA) life time Life time for security association. Default is 86400 seconds (1 day).	integer	Minimum: 21600 Maximum: 31536000 Default: "86400"
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

IPSecVpnLocalEndpoint (schema)

IPSec VPN Local Endpoint

Local endpoint represents a tier-0/tier-1 on which tunnel needs to be terminated.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
certificate_path	Certificate path Policy path referencing site certificate.	string
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
local_address	IPV4 Address of local endpoint IPV4 Address of local endpoint.	IPv4Address	Required
local_id	Local identifier Local identifier.	string
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 IPSecVpnLocalEndpoint	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
trust_ca_paths	Certificate authority (CA) paths List of policy paths referencing certificate authority (CA) to verify peer certificates.	array of string
trust_crl_paths	Certificate revocation list (CRL) paths List of policy paths referencing certificate revocation list (CRL) to peer certificates.	array of string
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

IPSecVpnRule (schema)

IPSec VPN Rule

For policy-based IPsec VPNs, a security policy specifies as its action the VPN tunnel to be used for transit traffic that meets the policy’s match criteria.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
action	Action to be applied PROTECT - Protect rules are defined per policy based IPSec VPN session. BYPASS - Bypass rules are defined per IPSec VPN service and affects all policy based IPSec VPN sessions. Bypass rules are prioritized over protect rules.	string	Readonly Enum: PROTECT, BYPASS Default: "PROTECT"
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
description	Description of this resource	string	Maximum length: 1024 Sortable
destinations	Destination list List of peer subnets. Specifying no value is interpreted as 0.0.0.0/0.	array of IPSecVpnSubnet	Maximum items: 128
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
enabled	Enabled flag A flag to enable/disable the rule.	boolean	Default: "True"
id	Unique identifier of this resource	string	Sortable
logged	Logging flag A flag to enable/disable the logging for the rule.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 IPSecVpnRule	string
sequence_number	Sequence number of the IPSecVpnRule A sequence number is used to give a priority to an IPSecVpnRule.	int	Minimum: 0
sources	Source list List of local subnets. Specifying no value is interpreted as 0.0.0.0/0.	array of IPSecVpnSubnet	Maximum items: 128
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

IPSecVpnService (schema)

IPSec VPN service

Create and manage IPSec VPN service for given locale service.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
bypass_rules	Bypass Policy rules Bypass policy rules are configured using VPN service. Bypass rules always have higher priority over protect rules and they affect all policy based vpn sessions associated with the IPSec VPN service. Protect rules are defined per policy based vpn session.	array of IPSecVpnRule
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
enabled	Enable virtual private network (VPN) service If true, enable VPN services for given locale service.	boolean	Default: "True"
ha_sync	Flag to enable IPSec HA State Sync Enable/disable IPSec HA state sync. IPSec HA state sync can be disabled if in case there are performance issues w.r.t. the state sync messages.	boolean	Default: "True"
id	Unique identifier of this resource	string	Sortable
ike_log_level	Internet key exchange (IKE) log level Log level for internet key exchange (IKE).	string	Enum: DEBUG, INFO, WARN, ERROR, EMERGENCY Default: "INFO"
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 IPSecVpnService	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

IPSecVpnSession (schema)

IPSec VPN session

VPN session defines connection between local and peer endpoint. Until VPN session is defined configuration is not realized. This is an abstract type. Concrete child types:
PolicyBasedIPSecVpnSession
RouteBasedIPSecVpnSession

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
authentication_mode	Authentication Mode Peer authentication mode. PSK - In this mode a secret key shared between local and peer sites is to be used for authentication. The secret key can be a string with a maximum length of 128 characters. CERTIFICATE - In this mode a certificate defined at the global level is to be used for authentication.	string	Enum: PSK, CERTIFICATE Default: "PSK"
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
compliance_suite	Compliance suite Compliance suite.	string	Enum: CNSA, SUITE_B_GCM_128, SUITE_B_GCM_256, PRIME, FOUNDATION, FIPS, NONE
connection_initiation_mode	Connection initiation mode Connection initiation mode used by local endpoint to establish ike connection with peer site. INITIATOR - In this mode local endpoint initiates tunnel setup and will also respond to incoming tunnel setup requests from peer gateway. RESPOND_ONLY - In this mode, local endpoint shall only respond to incoming tunnel setup requests. It shall not initiate the tunnel setup. ON_DEMAND - In this mode local endpoint will initiate tunnel creation once first packet matching the policy rule is received and will also respond to incoming initiation request.	string	Enum: INITIATOR, RESPOND_ONLY, ON_DEMAND Default: "INITIATOR"
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
dpd_profile_path	Dead peer detection (DPD) profile path Policy path referencing Dead Peer Detection (DPD) profile. Default is set to system default profile.	string
enabled	Enable/Disable IPSec VPN session Enable/Disable IPSec VPN session.	boolean	Default: "True"
id	Unique identifier of this resource	string	Sortable
ike_profile_path	Internet key exchange (IKE) profile path Policy path referencing IKE profile to be used. Default is set according to system default profile.	string
local_endpoint_path	Local endpoint path Policy path referencing Local endpoint.	string	Required
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
peer_address	IPV4 address of peer endpoint on remote site Public IPV4 address of the remote device terminating the VPN connection.	string	Required
peer_id	Peer id Peer ID to uniquely identify the peer site. The peer ID is the public IP address of the remote device terminating the VPN tunnel. When NAT is configured for the peer, enter the private IP address of the peer.	string	Required
psk	Pre-shared key IPSec Pre-shared key. Maximum length of this field is 128 characters.	string
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value IPSecVpnSession	IPSecVpnSessionResourceType	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
tcp_mss_clamping	TCP MSS Clamping TCP Maximum Segment Size Clamping Direction and Value.	TcpMaximumSegmentSizeClamping
tunnel_profile_path	IPSec tunnel profile path Policy path referencing Tunnel profile to be used. Default is set to system default profile.	string
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

IPSecVpnSessionResourceType (schema)

Resource types of IPsec VPN session

A Policy Based VPN requires to define protect rules that match
local and peer subnets. IPSec security associations is
negotiated for each pair of local and peer subnet.
A Route Based VPN is more flexible, more powerful and recommended over
policy based VPN. IP Tunnel port is created and all traffic routed via
tunnel port is protected. Routes can be configured statically
or can be learned through BGP. A route based VPN is must for establishing
redundant VPN session to remote site.

Name	Description	Type	Notes
IPSecVpnSessionResourceType	Resource types of IPsec VPN session A Policy Based VPN requires to define protect rules that match local and peer subnets. IPSec security associations is negotiated for each pair of local and peer subnet. A Route Based VPN is more flexible, more powerful and recommended over policy based VPN. IP Tunnel port is created and all traffic routed via tunnel port is protected. Routes can be configured statically or can be learned through BGP. A route based VPN is must for establishing redundant VPN session to remote site.	string	Enum: PolicyBasedIPSecVpnSession, RouteBasedIPSecVpnSession

IPSecVpnSubnet (schema)

Subnet for IPSec Policy based VPN

Used to specify the local/peer subnets in IPSec VPN rule.

Name	Description	Type	Notes
subnet	Peer or local subnet Subnet used in policy rule.	IPv4CIDRBlock	Required

IPSecVpnTunnelInterface (schema)

IP tunnel interface configuration

IP tunnel interface configuration.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
ip_subnets	IP Tunnel interface subnet IP Tunnel interface (commonly referred as VTI) subnet.	array of TunnelInterfaceIPSubnet	Required Minimum items: 1 Maximum items: 1
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 IPSecVpnTunnelInterface	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

IPSecVpnTunnelProfile (schema)

IPSec VPN tunnel profile

IPSec VPN tunnel profile is a reusable profile that captures phase two negotiation parameters and IPSec tunnel properties. Any changes affects all IPSec VPN sessions consuming this profile.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
description	Description of this resource	string	Maximum length: 1024 Sortable
df_policy	Policy for handling defragmentation bit Defragmentation policy helps to handle defragmentation bit present in the inner packet. COPY copies the defragmentation bit from the inner IP packet into the outer packet. CLEAR ignores the defragmentation bit present in the inner packet.	string	Enum: COPY, CLEAR Default: "COPY"
dh_groups	Dh group Diffie-Hellman group to be used if PFS is enabled. Default is GROUP14.	array of DhGroup
digest_algorithms	Algorithm for message hash Algorithm to be used for message digest. Default digest algorithm is implicitly covered by default encryption algorithm "AES_GCM_128".	array of IPSecDigestAlgorithm
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
enable_perfect_forward_secrecy	Enable perfect forward secrecy If true, perfect forward secrecy (PFS) is enabled.	boolean	Default: "True"
encryption_algorithms	Encryption algorithm to use in IPSec tunnel establishement Encryption algorithm to encrypt/decrypt the messages exchanged between IPSec VPN initiator and responder during tunnel negotiation. Default is AES_GCM_128.	array of IPSecEncryptionAlgorithm
extended_attributes	Extended Attributes. Collection of type specific properties. As of now, to hold encapsulation mode and transform protocol.	array of AttributeVal	Readonly
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 IPSecVpnTunnelProfile	string
sa_life_time	Security association (SA) life time SA life time specifies the expiry time of security association. Default is 3600 seconds.	integer	Minimum: 900 Maximum: 31536000 Default: "3600"
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

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

IPv4DiscoveryOptions (schema)

IPv4 discovery options

Contains IPv4 related discovery options.

Name	Description	Type	Notes
arp_snooping_config	ARP snooping configuration Indicates ARP snooping options	ArpSnoopingConfig
dhcp_snooping_enabled	Is DHCP snooping enabled or not Indicates whether DHCP snooping is enabled	boolean	Default: "True"
vmtools_enabled	Is VM tools enabled or not Indicates whether fetching IP using vm-tools is enabled. This option is only supported on ESX where vm-tools is installed.	boolean	Default: "True"

IPv6Address (schema)

IPv6 address

Name	Description	Type	Notes
IPv6Address	IPv6 address	string

IPv6DADStatus (schema)

IPv6 DAD status

Name	Description	Type	Notes
ip_address	IP address IP address on the port for which DAD status is reported.	IPAddress	Readonly
status	DAD Status DAD status for IP address on the port.	DADStatus	Readonly
transport_node	Transport node Array of transport node id on which DAD status is reported for given IP address.	array of ResourceReference	Readonly

IPv6DiscoveryOptions (schema)

IPv6 discovery options

Contains IPv6 related discovery options.

Name	Description	Type	Notes
dhcp_snooping_v6_enabled	Is DHCP snoping v6 enabled or not Enable this method will snoop the DHCPv6 message transaction which a VM makes with a DHCPv6 server. From the transaction, we learn the IPv6 addresses assigned by the DHCPv6 server to this VM along with its lease time.	boolean	Default: "False"
nd_snooping_config	ND snooping configuration Indicates ND snooping options	NdSnoopingConfig
vmtools_v6_enabled	Enable this method will learn the IPv6 addresses which are configured on interfaces of a VM with the help of the VMTools software.	boolean	Default: "False"

IPv6Status (schema)

IPv6 status

Name	Description	Type	Notes
connected_segment_path	Connected segment path Path of the segment attached to the interface.	string	Readonly
dad_statuses	IPv6 DAD status Array of DAD status which contains DAD information for IP addresses on the interface.	array of IPv6DADStatus	Readonly
interface_id	Policy path or realization ID of interface Policy path or realization ID of interface for which IPv6 DAD status is returned.	string

IcmpEchoRequestHeader (schema)

Name	Description	Type	Notes
id	ICMP id	integer	Minimum: 0 Maximum: 65535 Default: "0"
sequence	ICMP sequence number	integer	Minimum: 0 Maximum: 65535 Default: "0"

IcmpPolicyLbMonitorProfile (schema)

PolicyLbMonitorProfile for active health checks over ICMP

Active healthchecks are disabled by default and can be enabled for a
server pool by binding a health monitor to the Group through the PolicyLbRule
object. This represents active health monitoring over ICMP.
Active healthchecks are initiated periodically, at a configurable
interval, to each member of the Group. Only if a healthcheck fails
consecutively for a specified number of times (fall_count) to a member will
the member status be marked DOWN. Once a member is DOWN, a specified
number of consecutive successful healt hchecks (rise_count) will bring the
member back to UP state. After a healthcheck is initiated, if it does not
complete within a certain period, then also the healthcheck is considered
to be unsuccessful. Completing a healthcheck within timeout means establishing
a connection (TCP or SSL), if applicable, sending the request and
receiving the response, all within the configured timeout.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
fall_count	Monitor fall count for active healthchecks Only if a healthcheck fails consecutively for a specified number of times, given with fall_count, to a member will the member status be marked DOWN.	integer	Default: "3"
id	Unique identifier of this resource	string	Sortable
interval	Monitor interval in seconds for active healthchecks Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group.	integer	Default: "5"
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
monitor_port	Monitor port for active healthchecks Typically, monitors perform healthchecks to Group members using the member IP address and pool_port. However, in some cases, customers prefer to run healthchecks against a different port than the pool member port which handles actual application traffic. In such cases, the port to run healthchecks against can be specified in the monitor_port value.	int	Minimum: 0 Maximum: 65535
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 IcmpPolicyLbMonitorProfile	string	Required Enum: TcpPolicyLbMonitorProfile, UdpPolicyLbMonitorProfile, IcmpPolicyLbMonitorProfile, HttpPolicyLbMonitorProfile, HttpsPolicyLbMonitorProfile
rise_count	Monitor rise count for active healthchecks Once a member is DOWN, a specified number of consecutive successful healthchecks specified by rise_count will bring the member back to UP state.	integer	Default: "3"
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
timeout	Monitor timeout in seconds for active healthchecks Timeout specified in seconds. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.	integer	Default: "15"
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

Icon (schema)

Icon

Icon to be applied at dashboard for widgets and UI elements.

Name	Description	Type	Notes
placement	Position at which to display icon, if any If specified as PRE, the icon appears before the UI element. If set as POST, the icon appears after the UI element.	string	Enum: PRE, POST Default: "PRE"
tooltip	Multi-line tooltip Multi-line text to be shown on tooltip while hovering over the icon.	array of Tooltip
type	Type of icon Icon will be rendered based on its type. For example, if ERROR is chosen, then icon representing error will be rendered.	string	Enum: ERROR, WARNING, INFO, INPROGRESS, SUCCESS, DETAIL, NOT_AVAILABLE, SECURITY, NETWORKING, LOAD_BALANCER, VPN, DOMAIN, GROUP, DISTRIBUTED_FIREWALL, NETWORKING_TIER0, NETWORKING_TIER1, SEGMENT, SYSTEM, SYSTEM_FABRIC, SYSTEM_BACKUPRESTORE, INVENTORY_GROUPS, SECURITY_DFW

IdentityGroupExpression (schema)

IdentityGroup expression node

Represents a list of identity group (Ad group SID) expressions.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
identity_groups	Array of identity group This array consists of set of identity group object. All members within this array are implicitly OR'ed together.	array of IdentityGroupInfo	Required Minimum items: 1 Maximum items: 500
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 IdentityGroupExpression	string	Required Enum: Condition, ConjunctionOperator, NestedExpression, IPAddressExpression, MACAddressExpression, ExternalIDExpression, PathExpression, IdentityGroupExpression
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

IdentityGroupInfo (schema)

Identity (Directory) group

Name	Description	Type	Notes
distinguished_name	LDAP distinguished name Each LDAP object is uniquely identified by its distinguished name (DN). A DN is a sequence of relative distinguished names (RDN) connected by commas. e.g. CN=Larry Cole,CN=admin,DC=corp,DC=acme,DC=com. A valid fully qualified distinguished name should be provided to include specific groups else the create / update realization of the Group containing an invalid/ partial DN will fail. This value is valid only if it matches to exactly 1 LDAP object on the LDAP server.	string	Required
domain_base_distinguished_name	Identity (Directory) domain base distinguished name This is the base distinguished name for the domain where this particular group resides. (e.g. dc=example,dc=com) Each active directory domain has a domain naming context (NC), which contains domain-specific data. The root of this naming context is represented by a domain's distinguished name (DN) and is typically referred to as the NC head.	string	Required
sid	Identity (Directory) Group SID (security identifier) A security identifier (SID) is a unique value of variable length used to identify a trustee. A SID consists of the following components: The revision level of the SID structure; A 48-bit identifier authority value that identifies the authority that issued the SID; A variable number of subauthority or relative identifier (RID) values that uniquely identify the trustee relative to the authority that issued the SID. This field is only populated for Microsoft Active Directory identity store.	string

IdentitySourceLdapServer (schema)

An LDAP server

Information about a single LDAP server.

Name	Description	Type	Notes
bind_identity	Username or DN for LDAP authentication A username used to authenticate to the directory when admnistering roles in NSX. This user should have privileges to search the LDAP directory for groups and users. This user is also used in some cases (OpenLDAP) to look up an NSX user's distinguished name based on their NSX login name. If omitted, NSX will authenticate to the LDAP server using an LDAP anonymous bind operation. For Active Directory, provide a userPrincipalName (e.g. [email protected]) or the full distinguished nane. For OpenLDAP, provide the distinguished name of the user (e.g. uid=admin, cn=airius, dc=com).	string
certificates	TLS certificate(s) for LDAP server(s) If using LDAPS or STARTTLS, provide the X.509 certificate of the LDAP server in PEM format. This property is not required when connecting without TLS encryption and is ignored in that case.	array of string
enabled	If true, this LDAP server is enabled Allows the LDAP server to be enabled or disabled. When disabled, this LDAP server will not be used to authenticate users.	boolean	Default: "True"
password	Username for LDAP authentication A password used when authenticating to the directory.	string
url	The URL for the LDAP server The URL for the LDAP server. Supported URL schemes are LDAP and LDAPS. Either a hostname or an IP address may be given, and the port number is optional and defaults to 389 for the LDAP scheme and 636 for the LDAPS scheme.	string	Required
use_starttls	Enable/disable StartTLS If set to true, Use the StartTLS extended operation to upgrade the connection to TLS before sending any sensitive information. The LDAP server must support the StartTLS extended operation in order for this protocol to operate correctly. This option is ignored if the URL scheme is LDAPS.	boolean	Default: "False"

IdentitySourceLdapServerEndpoint (schema)

An LDAP server endpoint

Information about a single LDAP server endpoint.

Name	Description	Type	Notes
url	The URL for the LDAP server The URL for the LDAP server. Supported URL schemes are LDAP and LDAPS. Either a hostname or an IP address may be given, and the port number is optional and defaults to 389 for the LDAP scheme and 636 for the LDAPS scheme.	string	Required
use_starttls	Eanble/disable StartTLS If set to true, Use the StartTLS extended operation to upgrade the connection to TLS before sending any sensitive information. The LDAP server must support the StartTLS extended operation in order for this protocol to operate correctly. This option is ignored if the URL scheme is LDAPS.	boolean	Default: "False"

IdentitySourceLdapServerProbeResult (schema)

Results from one LDAP server probe

The results of probing an individual LDAP server.

Name	Description	Type	Notes
errors	Error details Detail about errors encountered during the probe.	array of LdapProbeError
result	Overall result Overall result of the probe. If the probe was able to connect to the LDAP service, authenticate using the provided credentials, and perform searches of the configured user and group search bases without error, the result is SUCCESS. Otherwise, the result is FAILURE, and additional details may be found in the errors property.	string	Enum: SUCCESS, FAILURE
url	LDAP Server URL THe URL of the probed LDAP host.	string

IdsClusterConfig (schema)

Intrusion Detection System cluster configuration

IDS configuration to enable/disable IDS on cluster level.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
cluster	PolicyResourceReference Contains policy resource reference object	PolicyResourceReference	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	Sortable
ids_enabled	Ids enabled flag If set to true, IDS is enabled on the respective cluster	boolean	Required
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 IdsClusterConfig	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

IdsProfile (schema)

Intrusion Detection System Profile

IDS Profile which contains the signatures and will be used in IDS rules.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
criteria	Filtering criteria of IDS Profile Represents the filtering criteria for the IDS Profile. 1. A non-empty criteria list, must be of odd size. In a list, with indices starting from 0, all IdsProfileFilterCriteria must be at even indices, separated by the IdsProfileConjunctionOperator AND at odd indices. 2. There may be at most 7 IdsProfileCriteria objects inside a list.	array of IdsProfileCriteria (Abstract type: pass one of the following concrete types) IdsProfileConjunctionOperator IdsProfileFilterCriteria	Maximum items: 7
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
overridden_signatures	Represents the signatures that is overridden for the Profile Represents the signatures that has been overridden for this Profile.	array of IdsProfileLocalSignature
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
profile_severity	IDS Profile severity Represents the severities of signatures which are part of this profile.	array of ProfileSeverity
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value IdsProfile	string
severities	IDS Profile severity Represents the severities of signatures which are part of this profile.	array of IdsProfileSeverity	Deprecated
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

IdsProfileConjunctionOperator (schema)

Represents the operator AND

Represents the operator AND.

Name	Description	Type	Notes
operator	IDS Profile Filter Condition	string	Required Enum: AND
resource_type	Must be set to the value IdsProfileConjunctionOperator	string	Required Enum: IdsProfileConjunctionOperator, IdsProfileFilterCriteria

IdsProfileCriteria (schema)

Base class for IDS Profile criteria

All the filtering criteria objects extend from this abstract class.
This is present for extensibility.
This is an abstract type. Concrete child types:
IdsProfileConjunctionOperator
IdsProfileFilterCriteria

Name	Description	Type	Notes
resource_type		string	Required Enum: IdsProfileConjunctionOperator, IdsProfileFilterCriteria

IdsProfileFilterCriteria (schema)

IDS Profile filter criteria

Represents the filtering criteria of a IDS Profile.

Name	Description	Type	Notes
filter_name	Represents the filter name Represents the filter for IDS Profile.	string	Required Enum: CVSS, ATTACK_TARGET, ATTACK_TYPE, PRODUCT_AFFECTED
filter_value	Represents the value of selected filter name Represents the value of selected filter name. Note : The supported values for filter name CVSS are NONE, LOW, MEDIUM, HIGH, CRITICAL. NONE means CVSS score as 0.0 LOW means CVSS score as 0.1-3.9 MEDIUM means CVSS score as 4.0-6.9 HIGH means CVSS score as 7.0-8.9 CRITICAL means CVSS score as 9.0-10.0	array of string	Required
resource_type	Must be set to the value IdsProfileFilterCriteria	string	Required Enum: IdsProfileConjunctionOperator, IdsProfileFilterCriteria

IdsProfileLocalSignature (schema)

IDS Profile local signature

IDS Profile local signature.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
action	Global IDS signature's action It denotes the global action of a IDS Signature. This will take precedence over IDS signature's action.	string	Enum: ALERT, DROP, REJECT
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
enable	Flag to Enable/Disable a IDS Signature globally. Flag through which user can Enable/Disable a Signature at Global Level.	boolean	Default: "True"
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 IdsProfileLocalSignature	string
signature_id	Signature ID Represents the Signature's id.	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

IdsProfileSeverity (schema)

Intrusion Detection System Profile severity

Intrusion Detection System Profile severity.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
ignore_signatures	Represents the signatures that will be ignored Contains the id of signatures that will be ignored as part of the profile. This field is deprecated, please use ignore_signatures field under IdsProfile to ignore the signatures.	array of string
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 IdsProfileSeverity	string
severity	Severity of profile Represents the severity of a profile.	string	Required Enum: CRITICAL, HIGH, MEDIUM, LOW
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

IdsRule (schema)

A rule specifies the IDS security policy rule between the workload groups

Represents the Intrusion Detection System rule which indicates the action to be performed for the corresponding workload 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.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
action	Action The action to be applied.	string	Enum: DETECT, DETECT_PREVENT
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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. Along with paths we support IP Address of type IPv4 and IPv6. IP Address can be in one of the format(CIDR, IP Address, Range of IP Address). 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	Maximum items: 128
destinations_excluded	Negation of destination groups If set to true, the rule gets applied on all the groups that are NOT part of the destination groups. If false, the rule applies to the destination groups	boolean	Default: "False"
direction	Direction Define direction of traffic.	string	Enum: IN, OUT, IN_OUT Default: "IN_OUT"
disabled	Flag to disable the rule Flag to disable the rule. Default is enabled.	boolean	Default: "False"
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
ids_profiles	IDS profiles collections of IDS profiles.	array of string	Minimum items: 1 Maximum items: 1
ip_protocol	IPv4 vs IPv6 packet type Type of IP packet that should be matched while enforcing the rule. The value is set to IPV4_IPV6 for Layer3 rule if not specified. For Layer2/Ether rule the value must be null.	string	Enum: IPV4, IPV6, IPV4_IPV6
is_default	Default rule flag A flag to indicate whether rule is a default rule.	boolean	Readonly
logged	Enable logging flag Flag to enable packet logging. Default is disabled.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
notes	Text for additional notes on changes Text for additional notes on changes.	string	Maximum length: 2048
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
profiles	Layer 7 service profiles Holds the list of layer 7 service profile paths. These profiles accept attributes and sub-attributes of various network services (e.g. L4 AppId, encryption algorithm, domain name, etc) as key value pairs.	array of string	Maximum items: 128
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value IdsRule	string
rule_id	Unique rule ID This is a unique 4 byte positive number that is assigned by the system. This rule id is passed all the way down to the data path. The first 1GB (1000 to 2^30) will be shared by GM and LM with zebra style striped number space. For E.g 1000 to (1Million -1) by LM, (1M - 2M-1) by GM and so on.	integer	Readonly
scope	The list of policy paths where the rule is applied LR/Edge/T0/T1/LRP etc. Note that a given rule can be applied on multiple LRs/LRPs.	array of string	Maximum items: 128
sequence_number	Sequence number of the this Rule This field is used to resolve conflicts between multiple Rules under Security or Gateway Policy for a Domain If no sequence number is specified in the payload, a value of 0 is assigned by default. If there are multiple rules with the same sequence number then their order is not deterministic. If a specific order of rules is desired, then one has to specify unique sequence numbers or use the POST request on the rule entity with a query parameter action=revise to let the framework assign a sequence number	int	Minimum: 0
service_entries	Raw services In order to specify raw services this can be used, along with services which contains path to services. This can be empty or null.	array of ServiceEntry (Abstract type: pass one of the following concrete types) ALGTypeServiceEntry EtherTypeServiceEntry ICMPTypeServiceEntry IGMPTypeServiceEntry IPProtocolServiceEntry L4PortSetServiceEntry NestedServiceServiceEntry	Maximum items: 128
services	Names of services 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	Maximum items: 128
source_groups	Source group paths We need paths as duplicate names may exist for groups under different domains. Along with paths we support IP Address of type IPv4 and IPv6. IP Address can be in one of the format(CIDR, IP Address, Range of IP Address). 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	Maximum items: 128
sources_excluded	Negation of source groups If set to true, the rule gets applied on all the groups that are NOT part of the source groups. If false, the rule applies to the source groups	boolean	Default: "False"
tag	Tag applied on the rule User level field which will be printed in CLI and packet logs.	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

IdsSecurityPolicy (schema)

Contains ordered list of IDS Rules

Represents the Intrusion Detection System Security Policy, which contains
the list of IDS Rules.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
category	A way to classify a security policy, if needed. - Distributed Firewall - Policy framework provides five pre-defined categories for classifying a security policy. They are "Ethernet","Emergency", "Infrastructure" "Environment" and "Application". There is a pre-determined order in which the policy framework manages the priority of these security policies. Ethernet category is for supporting layer 2 firewall rules. The other four categories are applicable for layer 3 rules. Amongst them, the Emergency category has the highest priority followed by Infrastructure, Environment and then Application rules. Administrator can choose to categorize a security policy into the above categories or can choose to leave it empty. If empty it will have the least precedence w.r.t the above four categories. - Edge Firewall - Policy Framework for Edge Firewall provides six pre-defined categories "Emergency", "SystemRules", "SharedPreRules", "LocalGatewayRules", "AutoServiceRules" and "Default", in order of priority of rules. All categories are allowed for Gatetway Policies that belong to 'default' Domain. However, for user created domains, category is restricted to "SharedPreRules" or "LocalGatewayRules" only. Also, the users can add/modify/delete rules from only the "SharedPreRules" and "LocalGatewayRules" categories. If user doesn't specify the category then defaulted to "Rules". System generated category is used by NSX created rules, for example BFD rules. Autoplumbed category used by NSX verticals to autoplumb data path rules. Finally, "Default" category is the placeholder default rules with lowest in the order of priority.	string
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
comments	SecurityPolicy lock/unlock comments Comments for security policy lock/unlock.	string
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
internal_sequence_number	Internal sequence number This field is to indicate the internal sequence number of a policy with respect to the policies across categories.	int	Readonly
is_default	Default policy flag A flag to indicate whether policy is a default policy.	boolean	Readonly
lock_modified_by	User who locked the security policy ID of the user who last modified the lock for the secruity policy.	string	Readonly
lock_modified_time	SecuirtyPolicy locked/unlocked time SecurityPolicy locked/unlocked time in epoch milliseconds.	EpochMsTimestamp	Readonly
locked	Lock a security policy Indicates whether a security policy should be locked. If the security policy is locked by a user, then no other user would be able to modify this security policy. Once the user releases the lock, other users can update this security policy.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 IdsSecurityPolicy	string
rule_count	Rule count The count of rules in the policy.	int	Readonly
rules	IDS Rules that are a part of this SecurityPolicy	array of IdsRule
scheduler_path	Path to the scheduler for time based scheduling Provides a mechanism to apply the rules in this policy for a specified time duration.	string
scope	The list of group paths where the rules in this policy will get applied. This scope will take precedence over rule level scope. Supported only for security and redirection policies. In case of RedirectionPolicy, it is expected only when the policy is NS and redirecting to service chain.	array of string	Maximum items: 128
sequence_number	Sequence number to resolve conflicts across Domains This field is used to resolve conflicts between security policies across domains. In order to change the sequence number of a policy one can fire a POST request on the policy entity with a query parameter action=revise The sequence number field will reflect the value of the computed sequence number upon execution of the above mentioned POST request. For scenarios where the administrator is using a template to update several security policies, the only way to set the sequence number is to explicitly specify the sequence number for each security policy. If no sequence number is specified in the payload, a value of 0 is assigned by default. If there are multiple policies with the same sequence number then their order is not deterministic. If a specific order of policies is desired, then one has to specify unique sequence numbers or use the POST request on the policy entity with a query parameter action=revise to let the framework assign a sequence number	int	Minimum: 0
stateful	Stateful nature of the entries within this security policy. Stateful or Stateless nature of security policy is enforced on all rules in this security policy. When it is stateful, the state of the network connects are tracked and a stateful packet inspection is performed. Layer3 security policies can be stateful or stateless. By default, they are stateful. Layer2 security policies can only be stateless.	boolean
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
tcp_strict	Enforce strict tcp handshake before allowing data packets Ensures that a 3 way TCP handshake is done before the data packets are sent. tcp_strict=true is supported only for stateful security policies. If the tcp_strict flag is not specified and the security policy is stateful, then tcp_strict will be set to true.	boolean
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

IdsSettings (schema)

Intrusion Detection System settings

Represents the Intrusion Detection System settings.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
auto_update	Auto update signatures flag Parameter to let the user decide whether to update the IDS Signatures automatically or not.	boolean	Default: "False"
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
ids_ever_enabled	Flag which tells whether IDS was ever enabled. Flag which tells whether IDS was ever enabled.	boolean	Readonly
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 IdsSettings	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

IdsSignature (schema)

Intrusion Detection System Signature

Intrusion Detection System Signature .

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
action	Represents the signature's action Signature action.	string
attack_target	Signature attack target Target of the signature.	string
categories	IDS Signature Internal category Represents the internal categories a signature belongs to.	array of IdsSignatureInternalCategory
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
class_type	Signature class type Class type of Signature.	string
cves	Represents the cve score. CVE score	array of string
cvss	CVSS of signature Represents the cvss value of a Signature. The value is derived from cvssv3 or cvssv2 score. NONE means cvssv3/cvssv2 score as 0.0 LOW means cvssv3/cvssv2 score as 0.1-3.9 MEDIUM means cvssv3/cvssv2 score as 4.0-6.9 HIGH means cvssv3/cvssv2 score as 7.0-8.9 CRITICAL means cvssv3/cvssv2 score as 9.0-10.0	string	Enum: NONE, LOW, MEDIUM, HIGH, CRITICAL
cvssv2	Signature cvssv2 score Signature cvssv2 score.	string
cvssv3	Signature cvssv3 score Signature cvssv3 score.	string
description	Description of this resource	string	Maximum length: 1024 Sortable
direction	Direction Source-destination direction.	string
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
enable	Enable/Disable flag Flag which tells whether the signature is enabled or not.	boolean
flow	Flow established. Flow established from server, from client etc.	string
id	Unique identifier of this resource	string	Sortable
malware_family	Malware Family Family of the malware tracked in the signature.	string
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
name	Represents the signature name Signature name.	string
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
performance_impact	Performance impact Performance impact of the signature.	string
policy	Policy Signature policy.	array of string
product_affected	Signature product affected Product affected by this signature.	string
protocol	Protocol Protocol used in the packet analysis.	string
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value IdsSignature	string
severity	Signature severity Represents the severity of the Signature.	string
signature_id	Signature ID Represents the Signature's id.	string
signature_revision	Signature revision Represents revision of the Signature.	string
signature_severity	Signature severity Signature vendor set severity of the signature rule.	string
tag	Signature tag Vendor assigned classification tag.	array of string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
type	Type Signature type.	array of string
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly
urls	List of mitre attack URLs pertaining to signature. List of mitre attack URLs pertaining to signature	array of string

IdsSignatureInternalCategory (schema)

IDS signature internal categories

Represents the internal categories.
APPLICATION : IDS signature having protocol comes under APPLICATION internal category.
MALWARE: IDS signature having malware_family comes under this internal category.
VULNERABILITY : IDS signature having cvssv3 score comes under this internal category.

Name	Description	Type	Notes
IdsSignatureInternalCategory	IDS signature internal categories Represents the internal categories. APPLICATION : IDS signature having protocol comes under APPLICATION internal category. MALWARE: IDS signature having malware_family comes under this internal category. VULNERABILITY : IDS signature having cvssv3 score comes under this internal category.	string	Enum: APPLICATION, MALWARE, VULNERABILITY

IdsSignatureStatus (schema)

Intrusion Detection System signature status

Ids signature status.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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
download_status	IDS signature download status READY means signatures were downloaded and parsed successfully. PENDING means that signatures download is in progress. ERROR means error occurred during signature processing. DISABLED means IDS is disabled.	string	Readonly Enum: READY, PENDING, ERROR, DISABLED
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 IdsSignatureStatus	string
signature_status	IDS signature status AVAILABLE means the signatures are available for the version. UNAVAILABLE means there are no available signatures for the version.	string	Readonly Enum: AVAILABLE, UNAVAILABLE
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly
version_id	Version Id Represents the version id.	string	Readonly

IdsStandaloneHostConfig (schema)

Intrusion Detection System configuration

IDS configuration to enable/disable IDS on standalone host level.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
ids_enabled	IDS enabled flag If set to true, IDS is enabled on standalone hosts.	boolean	Required
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 IdsStandaloneHostConfig	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

IkeDigestAlgorithm (schema)

Digest Algorithms used in IKE negotiations

The IkeDigestAlgorithms are used to verify message
integrity during Ike negotiation. SHA1 produces 160
bits hash and SHA2_XXX produces XXX bit hash.

Name	Description	Type	Notes
IkeDigestAlgorithm	Digest Algorithms used in IKE negotiations The IkeDigestAlgorithms are used to verify message integrity during Ike negotiation. SHA1 produces 160 bits hash and SHA2_XXX produces XXX bit hash.	string	Enum: SHA1, SHA2_256, SHA2_384, SHA2_512

IkeEncryptionAlgorithm (schema)

Encryption algorithms used in IKE

IKEEncryption algorithms are used to ensure confidentiality of
the messages exchanged during IKE negotiations. AES stands for
Advanced Encryption Standards. AES_128 uses 128-bit keys whereas
AES_256 uses 256-bit keys for encryption and decryption.
AES_GCM stands for Advanced Encryption Standard(AES) in
Galois/Counter Mode(GCM) and is used to provide both
confidentiality and data origin authentication. AES_GCM composed
of two separate functions one for encryption(AES) and one for
authentication(GMAC). AES_GCM algorithms will be available with
IKE_V2 version only.
AES_GCM_128 uses 128-bit keys.
AES_GCM_192 uses 192-bit keys.
AES_GCM_256 uses 256-bit keys.

Name	Description	Type	Notes
IkeEncryptionAlgorithm	Encryption algorithms used in IKE IKEEncryption algorithms are used to ensure confidentiality of the messages exchanged during IKE negotiations. AES stands for Advanced Encryption Standards. AES_128 uses 128-bit keys whereas AES_256 uses 256-bit keys for encryption and decryption. AES_GCM stands for Advanced Encryption Standard(AES) in Galois/Counter Mode(GCM) and is used to provide both confidentiality and data origin authentication. AES_GCM composed of two separate functions one for encryption(AES) and one for authentication(GMAC). AES_GCM algorithms will be available with IKE_V2 version only. AES_GCM_128 uses 128-bit keys. AES_GCM_192 uses 192-bit keys. AES_GCM_256 uses 256-bit keys.	string	Enum: AES_128, AES_256, AES_GCM_128, AES_GCM_192, AES_GCM_256

IncludedFieldsParameters (schema)

A list of fields to include in query results

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

Infra (schema)

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.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource (Abstract type: pass one of the following concrete types) ChildBfdProfile ChildConstraint ChildDhcpRelayConfig ChildDhcpServerConfig ChildDnsSecurityProfile ChildDomain ChildEvpnTenantConfig ChildFloodProtectionProfile ChildFullSyncState ChildGatewayQosProfile ChildGlobalManager ChildGlobalManagerConfig ChildIPDiscoveryProfile ChildIPFIXDFWCollectorProfile ChildIPFIXDFWProfile ChildIPFIXL2CollectorProfile ChildIPFIXL2Profile ChildIpv6DadProfile ChildIpv6NdraProfile ChildMacDiscoveryProfile ChildPolicyContextProfile ChildPolicyDnsForwarderZone ChildPolicyFirewallScheduler ChildPolicyFirewallSessionTimerProfile ChildPolicyLabel ChildPortMirroringProfile ChildQoSProfile ChildSegment ChildSegmentSecurityProfile ChildService ChildSite ChildSpan ChildSpoofGuardProfile ChildTier0 ChildTier1 ChildTlsCertificate ChildTlsCrl
connectivity_strategy	Connectivity strategy used by this tenant The connectivity strategy is deprecated. Use default layer3 rule, /infra/domains/default/security-policies/default-layer3-security-policy/rules/default-layer3-rule. 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 WHITELIST_ENABLE_LOGGING - Whitelising with logging enabled BLACKLIST_ENABLE_LOGGING - Blacklisting with logging enabled NONE - No default rules are added.	string	Deprecated Enum: WHITELIST, BLACKLIST, WHITELIST_ENABLE_LOGGING, BLACKLIST_ENABLE_LOGGING, 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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

IngressBroadcastRateLimiter (schema)

A shaper that specifies ingress rate properties in kb/s

Name	Description	Type	Notes
average_bandwidth	Average bandwidth in kb/s	int	Minimum: 0 Default: "0"
burst_size	Burst size in bytes	int	Minimum: 0 Default: "0"
enabled		boolean	Required
peak_bandwidth	Peak bandwidth in kb/s	int	Minimum: 0 Default: "0"
resource_type	Must be set to the value IngressBroadcastRateLimiter	string	Required Enum: IngressRateLimiter, IngressBroadcastRateLimiter, EgressRateLimiter Default: "IngressRateLimiter"

IngressRateLimiter (schema)

A shaper that specifies ingress rate properties in Mb/s

Name	Description	Type	Notes
average_bandwidth	Average bandwidth in Mb/s You can use the average bandwidth to reduce network congestion.	int	Minimum: 0 Default: "0"
burst_size	Burst size in bytes The burst duration is set in the burst size setting.	int	Minimum: 0 Default: "0"
enabled		boolean	Required
peak_bandwidth	Peak bandwidth in Mb/s The peak bandwidth rate is used to support burst traffic.	int	Minimum: 0 Default: "0"
resource_type	Must be set to the value IngressRateLimiter	string	Required Enum: IngressRateLimiter, IngressBroadcastRateLimiter, EgressRateLimiter Default: "IngressRateLimiter"

InitiateClusterRestoreRequest (schema)

Name	Description	Type	Notes
ip_address	IP address or FQDN of the node from which the backup was taken	string	Readonly
node_id	Unique id of the backed-up configuration from which the appliance will be restored	string	Required Readonly
timestamp	Timestamp of the backed-up configuration from which the appliance will be restored	EpochMsTimestamp	Required Readonly

Injection (schema)

Injection

Injection holding a key and a corresponding value.

Name	Description	Type	Notes
key	Key Injection key.	string	Required
value	Value Injection value.	InjectionValue (Abstract type: pass one of the following concrete types) UnaryOperationBasedInjectionValue	Required

InjectionValue (schema)

Injection Value

Injection Value.
This is an abstract type. Concrete child types:
UnaryOperationBasedInjectionValue

Name	Description	Type	Notes
resource_type	Resource Type Injection Value resource type.	string	Required Enum: UnaryOperationBasedInjectionValue

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)

Details of the instructions displayed during restore process

Name	Description	Type	Notes
actions	Actions list A list of actions that are to be applied to resources	array of string	Required Readonly
fields	Displayable fields A list of fields that are displayable to users in a table	array of string	Required Readonly
id	UUID of the instruction	string	Required Readonly
name	Instruction name	string	Required Readonly

IntentEnforcementPointListRequestParams (schema)

List request parameters containing intent path and enforcement point path

List request parameters containing intent path and enforcement point path

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
enforcement_point_path	String Path of the enforcement point The path of the enforcement point from which the list of groups needs to be fetched. Forward slashes must be escaped using %2F. If no enforcement point path is specified, the default enforcement point is considered	string
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
intent_path	String path of the intent object	string	Required
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

IntentPathRequestParameter (schema)

Parameter to filter realized entities by intent path

Intent path for which state/realized entities would be fetched.

Name	Description	Type	Notes
intent_path	String Path of the intent object Intent path of object, forward slashes must be escaped using %2F	string	Required
site_path	Policy Path of the site Policy Path referencing a site. This is applicable only on a GlobalManager. If no site_path is specified, then based on the span of the intent the response will be fetched from the respective sites	string

IntentRuntimeRequestParameters (schema)

Request Parameters for Intent Runtime Information

Request parameters that represents a an intent path.

Name	Description	Type	Notes
intent_path	Policy Path of the intent object Policy Path referencing an intent object.	string	Required
site_path	Policy Path of the site from where the realization status needs to be fetched Policy Path referencing a site. This is applicable only on a GlobalManager. If no site_path is specified, then based on the span of the intent the response will be fetched from the respective sites	string

IntentStatusRequestParameters (schema)

Request Parameters for Intent Status Information

Request parameters that represents a binding between an intent path and whether the
enforcement point specific status shall be retrieved from the enforcement point or
not. A request can be parameterized with this pair and will be evaluated as follows:
- : the request is evaluated on all enforcement points for the given
intent with no enforced statuses' details returned.
- : the request is evaluated on all
enforcement points for the given intent with enforced statuses' details returned.

Name	Description	Type	Notes
include_enforced_status	Include Enforced Status Flag Flag conveying whether to include detailed view of the enforcement point specific status or not.	boolean	Default: "False"
intent_path	Policy Path of the intent object Policy Path referencing an intent object.	string	Required
site_path	Policy Path of the site from where the realization status needs to be fetched Policy Path referencing a site. This is applicable only on a GlobalManager. If no site_path is specified, then based on the span of the intent the response will be fetched from the respective sites	string

InterSitePortCounters (schema)

Name	Description	Type	Notes
blocked_packets	The number of blocked packets The total number of packets blocked.	integer
dad_dropped_packets	The number of duplicate address detected packets dropped Number of duplicate address detected packets dropped.	integer
destination_unsupported_dropped_packets	The number of destination unsupported packets dropped Number of packtes dropped as destination is not supported.	integer
dropped_packets	The number of dropped packets The total number of packets dropped.	integer
firewall_dropped_packets	The number of firewall packets dropped Number of firewall packets dropped.	integer
frag_needed_dropped_packets	The number of fragmentation needed packets dropped Number of fragmentation needed packets dropped.	integer
ipsec_dropped_packets	The number of IPSec packets dropped Number of IPSec packets dropped	integer
ipsec_no_sa_dropped_packets	The number of IPSec no security association packets dropped Number of IPSec no security association packets dropped.	integer
ipsec_no_vti_dropped_packets	The number of IPSec no VTI packets dropped Number of IPSec packets dropped as no VTI is present.	integer
ipsec_pol_block_dropped_packets	The number of IPSec policy block packets dropped Number of IPSec policy block packets dropped.	integer
ipsec_pol_err_dropped_packets	The number of IPSec policy error packets dropped Number of IPSec policy error packets dropped.	integer
ipv6_dropped_packets	The number of IPV6 packets dropped Number of IPV6 packets dropped.	integer
kni_dropped_packets	The number of kernal NIC interface packets dropped Number of DPDK kernal NIC interface packets dropped.	integer
l4port_unsupported_dropped_packets	The number of L4 port unsupported packets dropped Number of packets dropped due to unsupported L4 port.	integer
malformed_dropped_packets	The number of malformed packets dropped Number of packtes dropped as they are malformed.	integer
no_arp_dropped_packets	The number of no ARP packets dropped Number of no ARP packets dropped.	integer
no_linked_dropped_packets	The number of no linked packets dropped Number of packets dropped as no linked ports are present.	integer
no_mem_dropped_packets	The number of no memory packets dropped Number of packets dropped due to insufficient memory.	integer
no_receiver_dropped_packets	The number of no receiver packets dropped Number of packets dropped due to absence of receiver.	integer
no_route_dropped_packets	The number of no route packets dropped	integer
non_ip_dropped_packets	The number of non IP packets dropped Number of non IP packets dropped.	integer
proto_unsupported_dropped_packets	The number of protocol unsupported packets dropped Number of packets dropped as protocol is unsupported.	integer
redirect_dropped_packets	The number of redirect packets dropped Number of redirect packets dropped.	integer
rpf_check_dropped_packets	The number of reverse-path forwarding check packets dropped Number of reverse-path forwarding check packets dropped.	integer
service_insert_dropped_packets	The number of service insert packets dropped Number of service insert packets dropped.	integer
total_bytes	The total number of bytes The total number of bytes transferred.	integer
total_packets	The total number of packets The total number of packets transferred.	integer
ttl_exceeded_dropped_packets	The number of time to live exceeded packets dropped Number of time to live exceeded packets dropped.	integer

InterfaceArpCsvRecord (schema)

Name	Description	Type	Notes
ip	The IP address	IPAddress	Required
mac_address	The MAC address	string	Required

InterfaceArpEntry (schema)

Name	Description	Type	Notes
ip	The IP address	IPAddress	Required
mac_address	The MAC address	string	Required

InterfaceArpProxy (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
arp_proxy_entries	Array of ARP proxy table entries	array of PolicyArpProxyEntry	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
interface_path	Policy path of gateway interface	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

InterfaceArpTable (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
edge_path	Policy path of edge node Policy path of edge node.	string
enforcement_point_path	Enforcement point path String Path of the enforcement point.	string
interface_path	The ID of the logical router port	string	Required
last_update_timestamp	Timestamp when the data was last updated; unset if data source has never updated the data.	EpochMsTimestamp	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results		array of InterfaceArpEntry
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

InterfaceArpTableInCsvFormat (schema)

Name	Description	Type	Notes
file_name	File name File name set by HTTP server if API returns CSV result as a file.	string
last_update_timestamp	Timestamp when the data was last updated; unset if data source has never updated the data.	EpochMsTimestamp	Readonly
results		array of InterfaceArpCsvRecord

InterfaceDADState (schema)

Interface DAD status

Duplicate address detection status on the interface.

Name	Description	Type	Notes
dad_statuses	IPv6 DAD status Array of DAD status which contains DAD information for IP addresses on the interface.	array of InterfaceIPv6DADStatus	Readonly
interface_path	Policy path or realization ID of interface Policy path or realization ID of interface for which IPv6 DAD status is returned.	string	Readonly

InterfaceIPv6DADStatus (schema)

IPv6 DAD status for Interface

Duplicate address detection status for IP address on the interface.

Name	Description	Type	Notes
edge_paths	Edge node paths Array of edge nodes on which DAD status is reported for given IP address.	array of string	Readonly
ip_address	IP address IP address on the port for which DAD status is reported.	IPAddress	Readonly
status	DAD Status DAD status for IP address on the port.	DADStatus	Readonly

InterfaceSubnet (schema)

Subnet specification for interface connectivity

Name	Description	Type	Notes
ip_addresses	IP addresses assigned to interface	array of IPAddress	Required
prefix_len	Subnet prefix length	int	Required Minimum: 1 Maximum: 128

IntersiteGatewayConfig (schema)

Intersite gateway configuration

Intersite gateway configuration.

Name	Description	Type	Notes
fallback_sites	Fallback sites Fallback site to be used as new primary site on current primary site failure. Disaster recovery must be initiated via API/UI. Fallback site configuration is supported only for T0 gateway. T1 gateway will follow T0 gateway's primary site during disaster recovery.	array of string
intersite_transit_subnet	Transit subnet in CIDR format IPv4 subnet for inter-site transit segment connecting service routers across sites for stretched gateway. For IPv6 link local subnet is auto configured.	string	Default: "169.254.32.0/20"
last_admin_active_epoch	Epoch of last time admin changing active LocaleServices Epoch(in seconds) is auto updated based on system current timestamp when primary locale service is updated. It is used for resolving conflict during site failover. If system clock not in sync then User can optionally override this. New value must be higher than the current value.	integer	Maximum: 4294967295
primary_site_path	Primary egress site for gateway. Primary egress site for gateway. T0/T1 gateway in Active/Standby mode supports stateful services on primary site. In this mode primary site must be set if gateway is stretched to more than one site. For T0 gateway in Active/Active primary site is optional field. If set then secondary site prefers routes learned from primary over locally learned routes. This field is not applicable for T1 gateway with no services.	string

IntervalBackupSchedule (schema)

Schedule to specify the interval time at which automated backups need to be taken

Name	Description	Type	Notes
resource_type	Must be set to the value IntervalBackupSchedule	string	Required Enum: WeeklyBackupSchedule, IntervalBackupSchedule
seconds_between_backups	Time interval in seconds between two consecutive automated backups	integer	Minimum: 300 Maximum: 86400 Default: "3600"

InvalidConfigSummary (schema)

Invalid Configuration Summary

Invalid Configuration details for a category.

Name	Description	Type	Notes
category	Configuration Category Configuration category representing resources not supported for the federation site configuration onboarding.	string	Required Readonly
resource_count	Resource Count Total resource count for category	integer	Required Readonly
resource_summary_details	Resource Summary List Represents list of resource summaries for a configuration category which are not supported for the federation site configuration onboarding.	array of ResourceSummaryDetail	Required Readonly Maximum items: 10

IpAddressAllocation (schema)

Parameters for IP allocation

Allocation parameters for the IP address (e.g. specific IP address) can be specified. Tags, display_name and description attributes are not supported in this release.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
allocation_ip	Address that is allocated from pool	IPAddress	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 IpAddressAllocation	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

IpAddressBlock (schema)

IP address space represented by network address and prefix

A block of IP addresses defined by a start address and a mask/prefix (network CIDR). An IP block is typically large & allocated to a tenant for automated consumption. An IP block is always a contiguous address space, for example 192.0.0.1/8. An IP block can be further subdivided into subnets called IP block subnets. These IP block subnets can be added to IP pools and used for IP allocation.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
cidr	A contiguous IP address space represented by network address and prefix length Represents a network address and the prefix length which will be associated with a layer-2 broadcast domain. Support IPv4 and IPv6 CIDR.	string	Required
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 IpAddressBlock	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

IpAddressInfo (schema)

Ipaddress information of the fabric node.

Name	Description	Type	Notes
ip_addresses	IP Addresses of the the virtual network interface, as discovered in the source.	array of IPAddress	Required Readonly
source	Source of the ipaddress information.	string	Required Readonly Enum: VM_TOOLS

IpAddressPool (schema)

A collection of IP subnets

IpAddressPool is a collection of subnets. The subnets can either be derived from an IpBlock or specified by the user. User can request for IP addresses to be allocated from a pool. When an IP is requested from a pool, the IP that is returned can come from any subnet that belongs to the pool.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
ip_release_delay	IP address release delay in milliseconds Delay in milliseconds, while releasing allocated IP address from IP pool (Default is 2 mins).	integer
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 IpAddressPool	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

IpAddressPoolBlockSubnet (schema)

IpAddressPoolSubnet dynamically carved out of a IpAddressBlock

This type of subnet allows user to dynamically carve a subnet out of a preconfigured IpAddressBlock. The user must specify the size of the subnet and the IpAddressBlock from which the subnet is to be derived. If the required amount of IP adress space is available in the specified IpAddressBlock, the system automatically configures subnet range.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
auto_assign_gateway	Indicate whether default gateway is to be reserved from the range If this property is set to true, the first IP in the range will be reserved for gateway.	boolean	Default: "True"
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
ip_block_path	The path of the IpAddressBlock from which the subnet is to be created.	string	Required
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 IpAddressPoolBlockSubnet	IpAddressPoolSubnetType	Required
size	Represents the size or number of IP addresses in the subnet The size parameter is required for subnet creation. It must be specified during creation but cannot be changed later.	integer	Required
start_ip	Represents start ip address of the subnet For internal system use Only. Represents start ip address of the subnet from IP block. Subnet ip adddress will start from this ip address.	IPAddress
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

IpAddressPoolStaticSubnet (schema)

IpAddressPoolSubnet statically configured by a user

This type of subnet is statically configured by the user. The user provides the range details and the gateway for the subnet.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
allocation_ranges	A collection of IPv4 or IPv6 IP Pool Ranges.	array of IpPoolRange	Required
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
cidr	Subnet representation is a network address and prefix length	string	Required
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
dns_nameservers	The collection of upto 3 DNS servers for the subnet.	array of IPAddress	Maximum items: 3
dns_suffix	The DNS suffix for the DNS server.	string
gateway_ip	The default gateway address on a layer-3 router.	IPAddress
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 IpAddressPoolStaticSubnet	IpAddressPoolSubnetType	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

IpAddressPoolSubnet (schema)

Abstract class for IpSubnet in a IpAddressPool

IpAddressPoolSubnet can either be carved out of a PolicyBlock or statically specified by the user. In the first case where the subnet is carved out of a IpAddressBlock, the user must specify the ID of the block from which this subnet is to be derived. This block must be pre-created. The subnet range is auto populated by the system. In the second case, the user configures the subnet range directly. No IpAddressBlock is required. This is an abstract type. Concrete child types:
IpAddressPoolBlockSubnet
IpAddressPoolStaticSubnet

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 IpAddressPoolSubnet	IpAddressPoolSubnetType	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

IpAddressPoolSubnetType (schema)

Type of IpAddressPoolSubnet

IpAddressPoolSubnet can either be carved out of a PolicyBlock or statically specified. A subnet to be carved out of a IpAddressBlock is of type IpAddressPoolBlockSubnet A subnet statically specified by the user is of type IpAddressPoolStaticSubnet

Name	Description	Type	Notes
IpAddressPoolSubnetType	Type of IpAddressPoolSubnet IpAddressPoolSubnet can either be carved out of a PolicyBlock or statically specified. A subnet to be carved out of a IpAddressBlock is of type IpAddressPoolBlockSubnet A subnet statically specified by the user is of type IpAddressPoolStaticSubnet	string	Enum: IpAddressPoolBlockSubnet, IpAddressPoolStaticSubnet

IpInfo (schema)

Only support IP address or subnet. Its type can be of
IPv4 or IPv6. It will be converted to subnet when netmask
is specified(e.g., 192.168.1.3/24 => 192.168.1.0/24,
2008:12:12:12::2/64 => 2008:12:12:12::/64).

Name	Description	Type	Notes
dst_ip	The destination IP address or subnet	IPElement
src_ip	The source IP address or subnet	IPElement

IpPoolRange (schema)

A set of IPv4 or IPv6 addresses defined by a start and end address.

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
end	The end IP Address of the IP Range.	IPAddress	Required
start	The start IP Address of the IP Range.	IPAddress	Required

Ipv4Header (schema)

Name	Description	Type	Notes
dst_ip	The destination ip address.	IPv4Address
flags	IP flags	integer	Minimum: 0 Maximum: 8 Default: "0"
protocol	IP protocol - defaults to ICMP	integer	Minimum: 0 Maximum: 255 Default: "1"
src_ip	The source ip address.	IPv4Address
src_subnet_prefix_len	source subnet prefix length. This is used together with src_ip to calculate dst_ip for broadcast when dst_ip is not given; not used in all other cases.	integer	Minimum: 1 Maximum: 32
ttl	Time to live (ttl)	integer	Minimum: 0 Maximum: 255 Default: "64"

Ipv6DadProfile (schema)

Duplicate address detection profile.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
dad_mode	DAD Mode	DADMode	Default: "LOOSE"
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
ns_retries	NS retries count Number of Neighbor solicitation packets generated before completing the Duplicate address detection process.	integer	Minimum: 0 Maximum: 10 Default: "3"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 Ipv6DadProfile	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly
wait_time	Wait time The time duration in seconds, to wait for Neighbor advertisement after sending the Neighbor solicitation message.	integer	Minimum: 0 Maximum: 60 Default: "1"

Ipv6DadProfileListResult (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Paginated list of Ipv6DadProfile	array of Ipv6DadProfile	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Ipv6Header (schema)

Name	Description	Type	Notes
dst_ip	The destination ip address.	IPv6Address
hop_limit	hop limit Decremented by 1 by each node that forwards the packets. The packet is discarded if Hop Limit is decremented to zero.	integer	Minimum: 0 Maximum: 255 Default: "64"
next_header	Identifies the type of header immediately following the IPv6 header.	integer	Minimum: 0 Maximum: 255 Default: "58"
src_ip	The source ip address.	IPv6Address

Ipv6NdraProfile (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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
dns_config	DNS Configurations	RaDNSConfig
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
ra_config	RA Configuration	RAConfig	Required
ra_mode	RA Mode	RAMode	Required Default: "SLAAC_DNS_THROUGH_RA"
reachable_timer	Reachable timer Neighbour reachable time duration in milliseconds. A value of 0 means unspecified.	integer	Minimum: 0 Maximum: 3600000 Default: "0"
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value Ipv6NdraProfile	string
retransmit_interval	Retransmission interval The time, in milliseconds, between retransmitted neighbour solicitation messages. A value of 0 means unspecified.	integer	Minimum: 0 Maximum: 4294967295 Default: "1000"
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

Ipv6NdraProfileListResult (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Paginated list of Ipv6NdraProfile	array of Ipv6NdraProfile	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

JoinClusterParameters (schema)

Parameters needed for this node to join the NSX cluster

To join a new node to the NSX cluster, issue a JoinCluster API on the new node. The JoinCluster API takes this object as a parameter. Provide the ID of the NSX cluster you want the new node to join and the IP address of one of the nodes already in that cluster. The Cluster Boot Manager running on the new node will then add the new node to the NSX cluster by making a AttachClusterNode REST API call on the node that is already part of the cluster. In order to make a REST API call to the node in the cluster, the Cluster Boot Manager will need username and password of a priviledged user on the node in the cluster. In place of a username and password, Cluster Boot Manager could also use a OAuth token provided. The Cluster Boot Manager needs either the username and password or the OAuth token to make the REST call but not both.

Name	Description	Type	Notes
certficate_sha256_thumbprint	SHA256 Thumbprint of the API certificate of the cluster node	string	Required
cluster_id	UUID of the cluster to join	string	Required
ip_address	IP address of a node already part of the cluster to join	string	Required
password	Password of the user on the cluster node	string
port	API port on the cluster node	integer	Minimum: 1 Maximum: 65535 Default: "443"
token	Limited time OAuth token instead of the username/password	string
username	Username on the cluster node	string

KeyValuePair (schema)

An arbitrary key-value pair

Name	Description	Type	Notes
key	Key	string	Required Maximum length: 255
value	Value	string	Required Maximum length: 255

KnownHostParameter (schema)

Name	Description	Type	Notes
host	Known host hostname or IP address	HostnameOrIPv4Address	Required
port	Known host port	integer	Minimum: 1 Maximum: 65535 Default: "22"

L2AutoRD (schema)

Layer 2 Auto assigned Route Distinguisher

Name	Description	Type	Notes
l2_auto_rd	Layer 2 auto assigned route distinghusher	string
l2_vni	Layer 2 Virtual Network Interface	string

L2BridgeEndpointProfile (schema)

Layer 2 Bridge Endpoint Profile

Used to configure L2 Bridge endpoint profile

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
edge_paths	List of path of Edge nodes List of policy paths to edge nodes. Edge allocation for L2 bridging.	array of string	Minimum items: 1 Maximum items: 2
failover_mode	Failover mode for the edge bridge cluster	string	Enum: PREEMPTIVE, NON_PREEMPTIVE Default: "PREEMPTIVE"
ha_mode	High availability mode for the edge bridge cluster High avaialability mode can be active-active or active-standby. High availability mode cannot be modified after realization.	string	Enum: ACTIVE_STANDBY Default: "ACTIVE_STANDBY"
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 L2BridgeEndpointProfile	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

L2Extension (schema)

Segment specific L2 VPN configuration

Name	Description	Type	Notes
l2vpn_path	Policy path of associated L2 VPN session This property has been deprecated. Please use the property l2vpn_paths for setting the paths of associated L2 VPN session. This property will continue to work as expected to provide backwards compatibility. However, when both l2vpn_path and l2vpn_paths properties are specified, only l2vpn_paths is used.	string	Deprecated
l2vpn_paths	Policy paths of associated L2 VPN sessions Policy paths corresponding to the associated L2 VPN sessions	array of string
local_egress	Local Egress Local Egress.	LocalEgress
tunnel_id	Tunnel ID	int	Minimum: 1 Maximum: 4093

L2ForwarderRemoteMacsPerSite (schema) (Experimental)

Name	Description	Type	Notes
remote_active_ips	Remote active IPs Remote active IP addresses.	array of IPAddress	Readonly
remote_mac_addresses	Remote mac addresses Remote mac addresses.	array of string	Readonly
remote_site	Remote site Remote site details.	ResourceReference	Required Readonly
remote_standby_ips	Remote standby IPs Remote standby IP addresses.	array of IPAddress	Readonly
rtep_group_id	RTEP group id of logical switch per site 32 bit unique RTEP group id of the logical switch per site.	integer	Required Readonly

L2ForwarderStatusPerNode (schema) (Experimental)

Name	Description	Type	Notes
high_availability_status	Service router's HA status High Availability status of a service router on the edge node.	string	Required Readonly Enum: ACTIVE, STANDBY, DOWN, SYNC, UNKNOWN
transport_node	Transport node Edge node details from where the router status is being retrieved.	ResourceReference	Required Readonly

L2L3RuntimeRequestParameters (schema)

L2 L3 connectivity runtime status request parameters

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
edge_path	Policy path of edge node Policy path of edge node. Edge should be member of enforcement point.	string
enforcement_point_path	String Path of the enforcement point Enforcement point path.	string
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

L2TcpMaxSegmentSizeClamping (schema)

TCP MSS Clamping

TCP MSS Clamping Direction and Value.

Name	Description	Type	Notes
direction	Maximum Segment Size Clamping Direction Specifies the traffic direction for which to apply MSS Clamping.	string	Enum: NONE, BOTH Default: "BOTH"
max_segment_size	Maximum Segment Size Value MSS defines the maximum amount of data that a host is willing to accept in a single TCP segment. This field is set in TCP header during connection establishment. To avoid packet fragmentation, you can set this field depending on uplink MTU and VPN overhead. This is an optional field and in case it is left unconfigured, best possible MSS value will be calculated based on effective mtu of uplink interface. Supported MSS range is 108 to 8852.	integer	Minimum: 108 Maximum: 8860

L2VPNService (schema)

L2VPN Service

L2VPN Service defines if service running as server or client. It also
defines all the common properties for the multiple L2VPN Sessions
associated with this service.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
enable_hub	Enable spoke to spoke (client) forwarding via hub (server) This property applies only in SERVER mode. If set to true, traffic from any client will be replicated to all other clients. If set to false, traffic received from clients is only replicated to the local VPN endpoint.	boolean	Default: "False"
encap_ip_pool	IP Pool for Logical Taps IP Pool to allocate local and peer endpoint IPs for L2VpnSession logical tap.	array of IPv4CIDRBlock
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
mode	L2VPN Service Mode Specify an L2VPN service mode as SERVER or CLIENT.	string	Enum: SERVER, CLIENT Default: "SERVER"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 L2VPNService	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

L2VPNSession (schema)

L2VPN Session

Defines the tunnel local and peer addresses along with multiple
tansport tunnels for redundancy. L2VPNSession belongs to only one
L2VPNService.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
enabled	Enable L2VPN session Enable to extend all the associated segments.	boolean	Default: "True"
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 L2VPNSession	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
tcp_mss_clamping	TCP MSS Clamping TCP Maximum Segment Size Clamping Direction and Value. This feature is supported for L2VPN Sessions that are Server mode only.	L2TcpMaxSegmentSizeClamping
transport_tunnels	List of transport tunnels List of transport tunnels for redundancy.	array of string	Required Minimum items: 1 Maximum items: 1
tunnel_encapsulation	Tunnel encapsulation config Tunnel encapsulation config. This property only applies in CLIENT mode. It is auto-populated from the L2VPNSessionData.	L2VPNTunnelEncapsulation	Readonly
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

L2VPNTunnelEncapsulation (schema)

L2VPN Tunnel Encapsulation

L2VPN tunnel encapsulation config.

Name	Description	Type	Notes
local_endpoint_address	IP Address of the tunnel port IP Address of the local tunnel port. This property only applies in CLIENT mode.	IPv4Address	Readonly
peer_endpoint_address	IP Address of the peer tunnel port IP Address of the peer tunnel port. This property only applies in CLIENT mode.	IPv4Address	Readonly
protocol	Encapsulation protocol Encapsulation protocol used by the tunnel.	string	Readonly Enum: GRE Default: "GRE"

L2Vpn (schema) (Deprecated)

L2 Virtual Private Network Configuration

Contains information necessary to configure L2Vpn.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
enabled	Enable L2Vpn Enable to extend all the associated segments.	boolean	Default: "True"
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 L2Vpn	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
transport_tunnels	List of paths referencing transport tunnels List of paths referencing transport tunnels.	array of string	Required Minimum items: 1 Maximum items: 1
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

L2VpnContext (schema) (Deprecated)

L2Vpn Context

L2Vpn Context provides meta-data information about the parent Tier-0.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
enable_hub	Enable to act as hub If enabled, the tier-0 acts as a Hub and replicates traffic received from peer to all other peers. If disabled, the tier-0 acts as a Spoke and replicates only the local.	boolean	Default: "False"
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 L2VpnContext	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

L3Vpn (schema) (Deprecated)

L3 Virtual Private Network Configuration

Contains information necessary to configure IPSec VPN.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
description	Description of this resource	string	Maximum length: 1024 Sortable
dh_groups	DH group Diffie-Hellman group to be used if PFS is enabled. Default group is GROUP14.	array of PolicyDHGroup	Maximum items: 1
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
enable_perfect_forward_secrecy	Enable perfect forward secrecy If true, perfect forward secrecy (PFS) is enabled.	boolean	Default: "True"
enabled	Enable L3Vpn Flag to enable L3Vpn. Default is enabled.	boolean	Default: "True"
id	Unique identifier of this resource	string	Sortable
ike_digest_algorithms	Digest Algorithm for IKE Algorithm to be used for message digest during Internet Key Exchange(IKE) negotiation. Default is SHA2_256.	array of PolicyIKEDigestAlgorithm	Maximum items: 1
ike_encryption_algorithms	Encryption algorithm for IKE Algorithm to be used during Internet Key Exchange(IKE) negotiation. Default is AES_128.	array of PolicyIKEEncryptionAlgorithm	Maximum items: 1
ike_version	IKE version IKE protocol version to be used. IKE-Flex will initiate IKE-V2 and responds to both IKE-V1 and IKE-V2.	PolicyIKEVersion	Default: "IKE_V2"
l3vpn_session	L3Vpn Session	L3VpnSession (Abstract type: pass one of the following concrete types) PolicyBasedL3VpnSession RouteBasedL3VpnSession	Required
local_address	IPv4 address of local gateway	IPv4Address	Required
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
passphrases	List of IPSec pre-shared keys List of IPSec pre-shared keys used for IPSec authentication. If not specified, the older passphrase values are retained if there are any.	array of string	Maximum items: 1
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
remote_private_address	Identifier of the remote site This field is used to resolve conflicts in case of a remote site being behind NAT as remote public ip address is not enough. If it is not the case the remote public address should be provided here. If not provided, the value of this field is set to remote_public_address.	string
remote_public_address	Public IPv4 address of remote gateway	IPv4Address	Required
resource_type	Must be set to the value L3Vpn	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
tunnel_digest_algorithms	Digest Algorithm for Tunnel Establishment Algorithm to be used for message digest during tunnel establishment. Default algorithm is empty.	array of PolicyTunnelDigestAlgorithm	Maximum items: 1
tunnel_encryption_algorithms	Encryption algorithm for Tunnel Establishement Encryption algorithm to encrypt/decrypt the messages exchanged between IPSec VPN initiator and responder during tunnel negotiation. Default is AES_GCM_128.	array of PolicyTunnelEncryptionAlgorithm	Maximum items: 1
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

L3VpnContext (schema) (Deprecated)

L3Vpn Context

L3Vpn Context provides the configuration context that different L3Vpns can consume.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
available_local_addresses	IPv4 addresses of the local gateway Local gateway IPv4 addresses available for configuration of each L3Vpn.	array of PolicyIPAddressInfo
bypass_rules	List of Bypass L3VpnRules Bypass L3Vpn rules that will be shared across L3Vpns. Only Bypass action is supported on these L3Vpn rules.	array of L3VpnRule
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
enabled	Enable L3 Virtual Private Network (VPN) service If true, enable L3Vpn Service for given tier-0. Enabling/disabling this service affects all L3Vpns under the given tier-0.	boolean	Default: "True"
id	Unique identifier of this resource	string	Sortable
ike_log_level	Internet key exchange (IKE) log level Log level for internet key exchange (IKE).	string	Enum: DEBUG, INFO, WARN, ERROR, EMERGENCY Default: "INFO"
label	Policy path referencing Label Policy path referencing Label. A label is used as a mechanism to group route-based L3Vpns in order to apply edge firewall rules on members' VTIs.	string
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 L3VpnContext	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

L3VpnRule (schema) (Deprecated)

L3Vpn Rule

For policy-based L3Vpn sessions, a rule specifies as its action the vpn tunnel to be used
for transit traffic that meets the rule's match criteria.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
action	Action to apply to the traffic transiting through the L3Vpn Action to exchange data with or without protection. PROTECT - Allows to exchange data with ipsec protection. Protect rules are defined per L3Vpn. BYPASS - Allows to exchange data without ipsec protection. Bypass rules are defined per L3VpnContext and affects all policy based L3Vpns. Bypass rules are prioritized over protect rules.	string	Enum: PROTECT, BYPASS Default: "PROTECT"
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
description	Description of this resource	string	Maximum length: 1024 Sortable
destinations	List of remote subnets List of remote subnets used in policy-based L3Vpn.	array of L3VpnSubnet	Required Minimum items: 1 Maximum items: 128
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 L3VpnRule	string
sequence_number	Sequence number of the L3VpnRule This field is used to resolve conflicts between multiple L3VpnRules associated with a single L3Vpn or L3VpnContext.	int
sources	List of local subnets List of local subnets used in policy-based L3Vpn.	array of L3VpnSubnet	Required Minimum items: 1 Maximum items: 128
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

L3VpnSession (schema) (Deprecated)

L3Vpn Session

Contains information about L3Vpn session.
This is an abstract type. Concrete child types:
PolicyBasedL3VpnSession
RouteBasedL3VpnSession

Name	Description	Type	Notes
resource_type		L3VpnSessionResourceType	Required

L3VpnSessionResourceType (schema) (Deprecated)

Resource type of L3Vpn Session

- A Policy Based L3Vpn is a configuration in which protect rules to match local
and remote subnet needs to be defined. Tunnel is established for each pair of
local and remote subnet defined in protect rules.
- A Route Based L3Vpn is more flexible, more powerful and recommended over policy
based. IP Tunnel subnet is created and all traffic routed through tunnel subnet
(commonly known as VTI) is sent over tunnel. Routes can be learned through BGP.
A route based L3Vpn is required when using redundant L3Vpn.

Name	Description	Type	Notes
L3VpnSessionResourceType	Resource type of L3Vpn Session - A Policy Based L3Vpn is a configuration in which protect rules to match local and remote subnet needs to be defined. Tunnel is established for each pair of local and remote subnet defined in protect rules. - A Route Based L3Vpn is more flexible, more powerful and recommended over policy based. IP Tunnel subnet is created and all traffic routed through tunnel subnet (commonly known as VTI) is sent over tunnel. Routes can be learned through BGP. A route based L3Vpn is required when using redundant L3Vpn.	string	Deprecated Enum: PolicyBasedL3VpnSession, RouteBasedL3VpnSession

L3VpnSubnet (schema) (Deprecated)

Subnet used in L3Vpn Rule

Used to specify subnets in L3Vpn rule.

Name	Description	Type	Notes
subnet	Subnet Subnet used in L3Vpn Rule.	IPv4CIDRBlock	Required

L4PolicyLbPersistenceProfile (schema)

PolicyLbPersistenceProflie for L4 type PolicyLbVirtualServer

Some applications maintain state and require all relevant connections
to be sent to the same server as the application state is not
synchronized among servers. Persistence is enabled on a
PolicyLbVirtualServer by binding a persistence profile to it.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
persistence	Persistence method used by PolicyLbVirtualServer(s) This field indicates the persistence method used for the PolicyLbVirtualServer. - SOURCE_IP persistence ensures all connections from a client (identified by IP address) are sent to the same backend server for a specified period. - This object is not required and persistence is disabled by default	string	Enum: SOURCE_IP Default: "SOURCE_IP"
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value L4PolicyLbPersistenceProfile	string	Required Enum: L4PolicyLbPersistenceProfile, L7PolicyLbPersistenceProfile, CustomPolicyLbPersistenceProfile
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

L4PortSetServiceEntry (schema)

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.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
description	Description of this resource	string	Maximum length: 1024 Sortable
destination_ports	Number of values should not exceed 15, ranges count as 2 values.	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	Sortable
l4_protocol		string	Required Enum: TCP, UDP
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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: IPProtocolServiceEntry, IGMPTypeServiceEntry, ICMPTypeServiceEntry, ALGTypeServiceEntry, L4PortSetServiceEntry, EtherTypeServiceEntry, NestedServiceServiceEntry
source_ports	Number of values should not exceed 15, ranges count as 2 values.	array of PortElement	Maximum items: 15
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

L7PolicyLbPersistenceProfile (schema)

PolicyLbPersistenceProflie for L7 type PolicyLbVirtualServer

Some applications maintain state and require all relevant connections
to be sent to the same server as the application state is not
synchronized among servers. Persistence is enabled on a
PolicyLbVirtualServer
by binding a persistence profile to it.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
persistence	Persistence method used by PolicyLbVirtualServer(s) This field indicates the persistence method used for the PolicyLbVirtualServer. - COOKIE persistence allows related client connections, identified by the same cookie in HTTP requests [Refer to HTTP Cookie for details on HTTP cookies], to be redirected to the same server. Load balancer does not maintain any persistence table for cookie persistence. Instead, it encodes the necessary information in the HTTP cookie value sent to client and relies on the client to store it and send it back in subsequent related HTTP requests. Hence there is no limit on the number of cookie persistence entries that can be supported. - This object is not required and persistence is disabled by default	string	Enum: COOKIE Default: "COOKIE"
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value L7PolicyLbPersistenceProfile	string	Required Enum: L4PolicyLbPersistenceProfile, L7PolicyLbPersistenceProfile, CustomPolicyLbPersistenceProfile
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

LBAccessListControl (schema)

IP access list control to filter the connections from clients

LBAccessListControl is used to define how IP access list control can filter
the connections from clients.

Name	Description	Type	Notes
action	IP access list control action ALLOW means connections matching grouping object IP list are allowed and requests not matching grouping object IP list are dropped. DROP means connections matching grouping object IP list are dropped and requests not matching grouping object IP list are allowed.	string	Required Enum: ALLOW, DROP
enabled	Whether to enable access list control option The enabled flag indicates whether to enable access list control option. It is false by default.	boolean	Default: "False"
group_path	Grouping object path The path of grouping object which defines the IP addresses or ranges to match the client IP.	string	Required

LBActiveMonitor (schema)

Base class for each type of active LBMonitorProfile

All the active types of LBMonitorProfile extend from this abstract class.
This is present for extensibility.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
fall_count	Monitor fall count for active healthchecks Only if a healthcheck fails consecutively for a specified number of times, given with fall_count, to a member will the member status be marked DOWN.	integer	Minimum: 1 Maximum: 2147483647 Default: "3"
id	Unique identifier of this resource	string	Sortable
interval	Monitor interval in seconds for active healthchecks Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group.	integer	Minimum: 1 Maximum: 2147483647 Default: "5"
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
monitor_port	Monitor port for active healthchecks Typically, monitors perform healthchecks to Group members using the member IP address and pool_port. However, in some cases, customers prefer to run healthchecks against a different port than the pool member port which handles actual application traffic. In such cases, the port to run healthchecks against can be specified in the monitor_port value. For ICMP monitor, monitor_port is not required.	int	Minimum: 0 Maximum: 65535
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 LBActiveMonitor	LBMonitorProfileType	Required
rise_count	Monitor rise count for active healthchecks Once a member is DOWN, a specified number of consecutive successful healthchecks specified by rise_count will bring the member back to UP state.	integer	Minimum: 1 Maximum: 2147483647 Default: "3"
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
timeout	Monitor timeout in seconds for active healthchecks Timeout specified in seconds. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.	integer	Minimum: 1 Maximum: 2147483647 Default: "5"
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

LBAppProfile (schema)

App profile

App profile. This is an abstract type. Concrete child types:
LBFastTcpProfile
LBFastUdpProfile
LBHttpProfile

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 LBAppProfile	LBApplicationProfileType	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

LBApplicationProfileType (schema)

Application profile type

An application profile can be bound to a virtual server
to specify the application protocol characteristics. It is used to
influence how load balancing is performed. Currently, three types of
application profiles are supported: LBFastTCPProfile,
LBFastUDPProfile and LBHttpProfile.
LBFastTCPProfile or LBFastUDPProfile is typically
used when the application is using a custom protocol or a standard protocol
not supported by the load balancer. It is also used in cases where the user
only wants L4 load balancing mainly because L4 load balancing has much
higher performance and scalability, and/or supports connection mirroring.
LBHttpProfile is used for both HTTP and HTTPS applications.
Though application rules, if bound to the virtual server, can be used
to accomplish the same goal, LBHttpProfile is intended to
simplify enabling certain common use cases.

Name	Description	Type	Notes
LBApplicationProfileType	Application profile type An application profile can be bound to a virtual server to specify the application protocol characteristics. It is used to influence how load balancing is performed. Currently, three types of application profiles are supported: LBFastTCPProfile, LBFastUDPProfile and LBHttpProfile. LBFastTCPProfile or LBFastUDPProfile is typically used when the application is using a custom protocol or a standard protocol not supported by the load balancer. It is also used in cases where the user only wants L4 load balancing mainly because L4 load balancing has much higher performance and scalability, and/or supports connection mirroring. LBHttpProfile is used for both HTTP and HTTPS applications. Though application rules, if bound to the virtual server, can be used to accomplish the same goal, LBHttpProfile is intended to simplify enabling certain common use cases.	string	Enum: LBHttpProfile, LBFastTcpProfile, LBFastUdpProfile

LBClientCertificateIssuerDnCondition (schema)

Match condition for client certficate issuer DN

Match condition for client certficate issuer DN.

Name	Description	Type	Notes
case_sensitive	A case sensitive flag for issuer DN comparing If true, case is significant when comparing issuer DN value.	boolean	Default: "True"
issuer_dn	Value of issuer DN Value of issuer DN.	string	Required
match_type	Match type of issuer DN Match type of issuer DN.	LbRuleMatchType	Default: "REGEX"

LBClientCertificateSubjectDnCondition (schema)

Match condition for client certficate subject DN

Match condition for client certficate subject DN.

Name	Description	Type	Notes
case_sensitive	A case sensitive flag for subject DN comparing If true, case is significant when comparing subject DN value.	boolean	Default: "True"
match_type	Match type of subject DN Match type of subject DN.	LbRuleMatchType	Default: "REGEX"
subject_dn	Value of subject DN Value of subject DN.	string	Required

LBClientSslProfile (schema)

Client SSL profile

Client SSL profile.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
cipher_group_label	Label of cipher group It is a label of cipher group which is mostly consumed by GUI.	SslCipherGroup
ciphers	Supported SSL cipher list to client side Supported SSL cipher list to client side.	array of SslCipher
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
is_fips	FIPS compliance of ciphers and protocols This flag is set to true when all the ciphers and protocols are FIPS compliant. It is set to false when one of the ciphers or protocols are not FIPS compliant..	boolean	Readonly
is_secure	Secure/Insecure SSL profile flag This flag is set to true when all the ciphers and protocols are secure. It is set to false when one of the ciphers or protocols is insecure.	boolean	Readonly
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
prefer_server_ciphers	Prefer server ciphers flag During SSL handshake as part of the SSL client Hello client sends an ordered list of ciphers that it can support (or prefers) and typically server selects the first one from the top of that list it can also support. For Perfect Forward Secrecy(PFS), server could override the client's preference.	boolean	Default: "True"
protocols	Supported SSL protocol list to client side SSL versions TLS1.1 and TLS1.2 are supported and enabled by default. SSLv2, SSLv3, and TLS1.0 are supported, but disabled by default.	array of SslProtocol
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value LBClientSslProfile	string
session_cache_enabled	Session cache enable/disable flag SSL session caching allows SSL client and server to reuse previously negotiated security parameters avoiding the expensive public key operation during handshake.	boolean	Default: "True"
session_cache_timeout	SSL session cache timeout value Session cache timeout specifies how long the SSL session parameters are held on to and can be reused.	integer	Minimum: 1 Maximum: 86400 Default: "300"
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

LBClientSslProfileBinding (schema)

Client SSL profile binding

Client SSL profile binding.

Name	Description	Type	Notes
certificate_chain_depth	The maximum traversal depth of client certificate chain Authentication depth is used to set the verification depth in the client certificates chain.	integer	Minimum: 1 Maximum: 2147483647 Default: "3"
client_auth	Client authentication mode Client authentication mode.	ClientAuthType	Default: "IGNORE"
client_auth_ca_paths	CA path list to verify client certificate If client auth type is REQUIRED, client certificate must be signed by one of the trusted Certificate Authorities (CAs), also referred to as root CAs, whose self signed certificates are specified.	array of string
client_auth_crl_paths	CRL path list to verify client certificate A Certificate Revocation List (CRL) can be specified in the client-side SSL profile binding to disallow compromised client certificates.	array of string
default_certificate_path	Default service certificate identifier A default certificate should be specified which will be used if the server does not host multiple hostnames on the same IP address or if the client does not support SNI extension.	string	Required
sni_certificate_paths	SNI certificate path list Client-side SSL profile binding allows multiple certificates, for different hostnames, to be bound to the same virtual server.	array of string
ssl_profile_path	Client SSL profile path Client SSL profile defines reusable, application-independent client side SSL properties.	string

LBConnectionDropAction (schema)

Action to drop connections

This action is used to drop the connections. There is no extra propery in
this action. If there is no match condition specified, the connection will
be always dropped. This action can be specified at HTTP_ACCESS or
HTTP_FORWARDING pahse.

Name	Description	Type	Notes
type	Must be set to the value LBConnectionDropAction	LBRuleActionType	Required

LBCookiePersistenceProfile (schema)

LBPersistenceProflie using Cookies for L7 LBVirtualServer

Some applications maintain state and require all relevant connections
to be sent to the same server as the application state is not
synchronized among servers. Persistence is enabled on a
LBVirtualServer by binding a persistence profile to it.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
cookie_domain	Cookie domain HTTP cookie domain could be configured, only available for insert mode.	string
cookie_fallback	Cookie persistence fallback If fallback is true, once the cookie points to a server that is down (i.e. admin state DISABLED or healthcheck state is DOWN), then a new server is selected by default to handle that request. If fallback is false, it will cause the request to be rejected if cookie points to a server.	boolean	Default: "True"
cookie_garble	Cookie persistence garble If garble is set to true, cookie value (server IP and port) would be encrypted. If garble is set to false, cookie value would be plain text.	boolean	Default: "True"
cookie_httponly	Cookie httponly flag If cookie httponly flag is true, it prevents a script running in the browser from accessing the cookie. Only available for insert mode.	boolean	Default: "False"
cookie_mode	Cookie persistence mode Cookie persistence mode.	CookiePersistenceModeType	Default: "INSERT"
cookie_name	Cookie name Cookie name.	string	Default: "NSXLB"
cookie_path	Cookie path HTTP cookie path could be set, only available for insert mode.	string
cookie_secure	Cookie secure flag If cookie secure flag is true, it prevents the browser from sending a cookie over http. The cookie is sent only over https. Only available for insert mode.	boolean	Default: "False"
cookie_time	Cookie time setting Both session cookie and persistence cookie are supported, if not specified, it's a session cookie. It expires when the browser is closed.	LBCookieTime (Abstract type: pass one of the following concrete types) LBPersistenceCookieTime LBSessionCookieTime
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
persistence_shared	Persistence shared across LBVirtualServers Persistence shared setting indicates that all LBVirtualServers that consume this LBPersistenceProfile should share the same persistence mechanism when enabled. Meaning, persistence entries of a client accessing one virtual server will also affect the same client's connections to a different virtual server. For example, say there are two virtual servers vip-ip1:80 and vip-ip1:8080 bound to the same Group g1 consisting of two servers (s11:80 and s12:80). By default, each virtual server will have its own persistence table or cookie. So, in the earlier example, there will be two tables (vip-ip1:80, p1) and (vip-ip1:8080, p1) or cookies. So, if a client connects to vip1:80 and later connects to vip1:8080, the second connection may be sent to a different server than the first. When persistence_shared is enabled, then the second connection will always connect to the same server as the original connection. For COOKIE persistence type, the same cookie will be shared by multiple virtual servers. For SOURCE_IP persistence type, the persistence table will be shared across virtual servers. For GENERIC persistence type, the persistence table will be shared across virtual servers which consume the same persistence profile in LBRule actions.	boolean	Default: "False"
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value LBCookiePersistenceProfile	string	Required Enum: LBSourceIpPersistenceProfile, LBCookiePersistenceProfile, LBGenericPersistenceProfile
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

LBCookieTime (schema)

Cookie time

Cookie time. This is an abstract type. Concrete child types:
LBPersistenceCookieTime
LBSessionCookieTime

Name	Description	Type	Notes
type		LBCookieTimeType	Required

LBCookieTimeType (schema)

CookieTime type

Both session cookie and persistence cookie are supported,
Use LbSessionCookieTime for session cookie time setting,
Use LbPersistenceCookieTime for persistence cookie time setting

Name	Description	Type	Notes
LBCookieTimeType	CookieTime type Both session cookie and persistence cookie are supported, Use LbSessionCookieTime for session cookie time setting, Use LbPersistenceCookieTime for persistence cookie time setting	string	Enum: LBSessionCookieTime, LBPersistenceCookieTime

LBFastTcpProfile (schema)

Fast TCP profile

Fast TCP profile.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
close_timeout	TCP connection idle timeout in seconds It is used to specify how long a closing TCP connection (both FINs received or a RST is received) should be kept for this application before cleaning up the connection.	integer	Minimum: 1 Maximum: 60 Default: "8"
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
ha_flow_mirroring_enabled	Flow mirroring enabled flag If flow mirroring is enabled, all the flows to the bounded virtual server are mirrored to the standby node.	boolean	Default: "False"
id	Unique identifier of this resource	string	Sortable
idle_timeout	TCP connection idle timeout in seconds It is used to configure how long an idle TCP connection in ESTABLISHED state should be kept for this application before cleaning up.	integer	Minimum: 1 Maximum: 2147483647 Default: "1800"
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 LBFastTcpProfile	LBApplicationProfileType	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

LBFastUdpProfile (schema)

Fast UDP profile

Fast UDP profile.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
flow_mirroring_enabled	Flow mirroring enabled flag If flow mirroring is enabled, all the flows to the bounded virtual server are mirrored to the standby node.	boolean	Default: "False"
id	Unique identifier of this resource	string	Sortable
idle_timeout	UDP idle timeout in seconds Though UDP is a connectionless protocol, for the purposes of load balancing, all UDP packets with the same flow signature (source and destination IP/ports and IP protocol) received within the idle timeout period are considered to belong to the same connection and are sent to the same backend server. If no packets are received for idle timeout period, the connection (association between flow signature and the selected server) is cleaned up.	integer	Minimum: 1 Maximum: 2147483647 Default: "300"
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 LBFastUdpProfile	LBApplicationProfileType	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

LBGenericPersistenceProfile (schema)

LB generic persistence profile

Some applications maintain state and require all relevant connections
to be sent to the same server as the application state is not
synchronized among servers. Persistence is enabled on a
LBVirtualServer by binding a persistence profile to it.
LBGenericPersistenceProfile cannot be attached to virtual server directly,
it can be specified in LB rule actions. In HTTP forwarding phase,
the profile can be specified in LBVariablePersistenceOnAction. In HTTP
response rewriting phase, the profile can be specified in
LBVariablePersistenceLearnAction.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
ha_persistence_mirroring_enabled	Mirroring enabled flag The mirroring enabled flag is to synchronize persistence entries. Persistence entries are not synchronized to the HA peer by default.	boolean	Default: "False"
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
persistence_shared	Persistence shared across LBVirtualServers Persistence shared setting indicates that all LBVirtualServers that consume this LBPersistenceProfile should share the same persistence mechanism when enabled. Meaning, persistence entries of a client accessing one virtual server will also affect the same client's connections to a different virtual server. For example, say there are two virtual servers vip-ip1:80 and vip-ip1:8080 bound to the same Group g1 consisting of two servers (s11:80 and s12:80). By default, each virtual server will have its own persistence table or cookie. So, in the earlier example, there will be two tables (vip-ip1:80, p1) and (vip-ip1:8080, p1) or cookies. So, if a client connects to vip1:80 and later connects to vip1:8080, the second connection may be sent to a different server than the first. When persistence_shared is enabled, then the second connection will always connect to the same server as the original connection. For COOKIE persistence type, the same cookie will be shared by multiple virtual servers. For SOURCE_IP persistence type, the persistence table will be shared across virtual servers. For GENERIC persistence type, the persistence table will be shared across virtual servers which consume the same persistence profile in LBRule actions.	boolean	Default: "False"
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value LBGenericPersistenceProfile	string	Required Enum: LBSourceIpPersistenceProfile, LBCookiePersistenceProfile, LBGenericPersistenceProfile
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
timeout	Persistence entry expiration time in seconds When all connections complete (reference count reaches 0), persistence entry timer is started with the expiration time.	integer	Minimum: 1 Maximum: 2147483647 Default: "300"
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

LBHttpMonitorProfile (schema)

LBMonitorProfile for active health checks over HTTP

Active healthchecks are disabled by default and can be enabled for a
server pool by binding a health monitor to the Group through the LBRule
object. This represents active health monitoring over HTTP.
Active healthchecks are initiated periodically, at a configurable
interval, to each member of the Group. Only if a healthcheck fails
consecutively for a specified number of times (fall_count) to a member will
the member status be marked DOWN. Once a member is DOWN, a specified
number of consecutive successful healthchecks (rise_count) will bring the
member back to UP state. After a healthcheck is initiated, if it does not
complete within a certain period, then also the healthcheck is considered
to be unsuccessful.
Completing a healthcheck within timeout means establishing a connection
(TCP or SSL), if applicable, sending the request and receiving the
response, all within the configured timeout.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
fall_count	Monitor fall count for active healthchecks Only if a healthcheck fails consecutively for a specified number of times, given with fall_count, to a member will the member status be marked DOWN.	integer	Minimum: 1 Maximum: 2147483647 Default: "3"
id	Unique identifier of this resource	string	Sortable
interval	Monitor interval in seconds for active healthchecks Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group.	integer	Minimum: 1 Maximum: 2147483647 Default: "5"
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
monitor_port	Monitor port for active healthchecks Typically, monitors perform healthchecks to Group members using the member IP address and pool_port. However, in some cases, customers prefer to run healthchecks against a different port than the pool member port which handles actual application traffic. In such cases, the port to run healthchecks against can be specified in the monitor_port value. For ICMP monitor, monitor_port is not required.	int	Minimum: 0 Maximum: 65535
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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
request_body	HTTP health check request body String to send as part of HTTP health check request body. Valid only for certain HTTP methods like POST.	string
request_headers	Array of HTTP request headers Array of HTTP request headers.	array of LbHttpRequestHeader
request_method	The health check method for HTTP monitor type The health check method for HTTP monitor type.	HttpRequestMethodType	Default: "GET"
request_url	Customized HTTP request url for active health checks For HTTP active healthchecks, the HTTP request url sent can be customized and can include query parameters.	string	Default: "/"
request_version	HTTP request version HTTP request version.	HttpRequestVersionType	Default: "HTTP_VERSION_1_1"
resource_type	Must be set to the value LBHttpMonitorProfile	LBMonitorProfileType	Required
response_body	Response body to match If HTTP response body match string (regular expressions not supported) is specified (using LBHttpMonitor.response_body) then the healthcheck HTTP response body is matched against the specified string and server is considered healthy only if there is a match. If the response body string is not specified, HTTP healthcheck is considered successful if the HTTP response status code is 2xx, but it can be configured to accept other status codes as successful.	string
response_status_codes	Array of single HTTP response status codes The HTTP response status code should be a valid HTTP status code.	array of int	Maximum items: 64
rise_count	Monitor rise count for active healthchecks Once a member is DOWN, a specified number of consecutive successful healthchecks specified by rise_count will bring the member back to UP state.	integer	Minimum: 1 Maximum: 2147483647 Default: "3"
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
timeout	Monitor timeout in seconds for active healthchecks Timeout specified in seconds. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.	integer	Minimum: 1 Maximum: 2147483647 Default: "5"
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

LBHttpProfile (schema)

Http profile

Http profile.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
http_redirect_to	Http redirect static URL If a website is temporarily down or has moved, incoming requests for that virtual server can be temporarily redirected to a URL.	string
http_redirect_to_https	Flag to indicate whether enable HTTP-HTTPS redirect Certain secure applications may want to force communication over SSL, but instead of rejecting non-SSL connections, they may choose to redirect the client automatically to use SSL.	boolean	Default: "False"
id	Unique identifier of this resource	string	Sortable
idle_timeout	HTTP application idle timeout in seconds It is used to specify the HTTP application idle timeout, it means that how long the load balancer will keep the connection idle to wait for the client to send the next keep-alive request. It is not a TCP socket setting.	integer	Minimum: 1 Maximum: 5400 Default: "15"
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
ntlm	NTLM support flag NTLM is an authentication protocol that can be used over HTTP. If the flag is set to true, LB will use NTLM challenge/response methodology. This property is deprecated. Please use the property server_keep_alive in order to keep the backend server connection alive for the client connection. When create a new profile, if both ntlm and server_keep_alive are set as different values, ERROR will be reported. When update an existing profile, if either ntlm or server_keep_alive value is changed, both of them are updated with the changed value.	boolean	Deprecated
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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
request_body_size	Maximum size of the buffer used to store HTTP request body If it is not specified, it means that request body size is unlimited.	integer	Minimum: 1 Maximum: 2147483647
request_header_size	Maximum size of the buffer used to store HTTP request headers A request with header equal to or below this size is guaranteed to be processed. A request with header larger than request_header_size will be processed up to 32K bytes on best effort basis.	integer	Minimum: 1 Default: "1024"
resource_type	Must be set to the value LBHttpProfile	LBApplicationProfileType	Required
response_buffering	Enable or disable buffering of responses When buffering is disabled, the response is passed to a client synchronously, immediately as it is received. When buffering is enabled, LB receives a response from the backend server as soon as possible, saving it into the buffers.	boolean	Default: "False"
response_header_size	Maximum size of the buffer used to store HTTP response headers A response with header larger than response_header_size will be dropped.	integer	Minimum: 1 Maximum: 65536 Default: "4096"
response_timeout	Maximum server idle time in seconds If server doesn’t send any packet within this time, the connection is closed.	integer	Minimum: 1 Maximum: 2147483647 Default: "60"
server_keep_alive	Server keep-alive flag If server_keep_alive is true, it means the backend connection will keep alive for the client connection. Every client connection is tied 1:1 with the corresponding server-side connection. If server_keep_alive is false, it means the backend connection won't keep alive for the client connection. If server_keep_alive is not specified for API input, its value in API output will be the same with the property ntlm.	boolean
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly
x_forwarded_for	Insert or replace x_forwarded_for When X-Forwareded-For is configured, X-Forwarded-Proto and X-Forwarded-Port information is added automatically. The two additional header information can be also modified or deleted in load balancer rules.	LBXForwardedForType

LBHttpRedirectAction (schema)

Action to redirect HTTP request messages

This action is used to redirect HTTP request messages to a new URL. The
reply_status value specified in this action is used as the status code of
HTTP response message which is sent back to client (Normally a browser).
The HTTP status code for redirection is 3xx, for example, 301, 302, 303,
307, etc. The redirect_url is the new URL that the HTTP request message is
redirected to. Normally browser will send another HTTP request to the new
URL after receiving a redirection response message.
Captured variables and built-in variables can be used in redirect_url field.
For example, to redirect all HTTP requests to HTTPS requests for a virtual
server. We create an LBRule without any conditions, add an
LBHttpRedirectAction to the rule. Set the
redirect_url field of the LBHttpRedirectAction to:
https://$_host$_request_uri
And set redirect_status to "302", which means found. This rule will
redirect all HTTP requests to HTTPS server port on the same host.

Name	Description	Type	Notes
redirect_status	HTTP response status code HTTP response status code.	string	Required
redirect_url	The URL that the HTTP request is redirected to The URL that the HTTP request is redirected to.	string	Required
type	Must be set to the value LBHttpRedirectAction	LBRuleActionType	Required

LBHttpRejectAction (schema)

Action to reject HTTP request messages

This action is used to reject HTTP request messages. The specified
reply_status value is used as the status code for the corresponding HTTP
response message which is sent back to client (Normally a browser)
indicating the reason it was rejected. Reference official HTTP status code
list for your specific HTTP version to set the reply_status properly.
LBHttpRejectAction does not support variables.

Name	Description	Type	Notes
reply_message	Response message Response message.	string
reply_status	HTTP response status code HTTP response status code.	string	Required
type	Must be set to the value LBHttpRejectAction	LBRuleActionType	Required

LBHttpRequestBodyCondition (schema)

Condition to match content of HTTP request message body

This condition is used to match the message body of an HTTP request.
Typically, only HTTP POST, PATCH, or PUT requests have request body.
The match_type field defines how body_value field is used to match the body
of HTTP requests.

Name	Description	Type	Notes
body_value	HTTP request body	string	Required
case_sensitive	A case sensitive flag for HTTP body comparing If true, case is significant when comparing HTTP body value.	boolean	Default: "True"
inverse	A flag to indicate whether reverse the match result of this condition	boolean	Default: "False"
match_type	Match type of HTTP body	LbRuleMatchType	Default: "REGEX"
type	Must be set to the value LBHttpRequestBodyCondition	LBRuleConditionType	Required

LBHttpRequestCookieCondition (schema)

Condition to match HTTP request cookie

This condition is used to match HTTP request messages by cookie which is a
specific type of HTTP header. The match_type and case_sensitive define how
to compare cookie value.

Name	Description	Type	Notes
case_sensitive	A case sensitive flag for cookie value comparing If true, case is significant when comparing cookie value.	boolean	Default: "True"
cookie_name	Name of cookie Cookie name.	string	Required
cookie_value	Value of cookie Cookie value.	string	Required
inverse	A flag to indicate whether reverse the match result of this condition	boolean	Default: "False"
match_type	Match type of cookie value Match type of cookie value.	LbRuleMatchType	Default: "REGEX"
type	Must be set to the value LBHttpRequestCookieCondition	LBRuleConditionType	Required

LBHttpRequestHeaderCondition (schema)

Condition to match HTTP request header

This condition is used to match HTTP request messages by HTTP header
fields. HTTP header fields are components of the header section of HTTP
request and response messages. They define the operating parameters of an
HTTP transaction. For example, Cookie, Authorization, User-Agent, etc. One
condition can be used to match one header field, to match multiple header
fields, multiple conditions must be specified.
The match_type field defines how header_value field is used to match HTTP
requests. The header_name field does not support match types.

Name	Description	Type	Notes
case_sensitive	A case sensitive flag for HTTP header value comparing If true, case is significant when comparing HTTP header value.	boolean	Default: "True"
header_name	Name of HTTP header	string	Default: "Host"
header_value	Value of HTTP header	string	Required
inverse	A flag to indicate whether reverse the match result of this condition	boolean	Default: "False"
match_type	Match type of HTTP header value	LbRuleMatchType	Default: "REGEX"
type	Must be set to the value LBHttpRequestHeaderCondition	LBRuleConditionType	Required

LBHttpRequestHeaderDeleteAction (schema)

Action to delete HTTP request header fields

This action is used to delete header fields of HTTP request messages at
HTTP_REQUEST_REWRITE phase. One action can be used to delete all headers
with same header name. To delete headers with different header names,
multiple actions must be defined.

Name	Description	Type	Notes
header_name	Name of a header field of HTTP request message Name of a header field of HTTP request message.	string	Required
type	Must be set to the value LBHttpRequestHeaderDeleteAction	LBRuleActionType	Required

LBHttpRequestHeaderRewriteAction (schema)

Action to rewrite header fields of HTTP request messages

This action is used to rewrite header fields of matched HTTP request
messages to specified new values. One action can be used to rewrite one
header field. To rewrite multiple header fields, multiple actions must be
defined.
Captured variables and built-in variables can be used in the header_value
field, header_name field does not support variables.

Name	Description	Type	Notes
header_name	Name of HTTP request header Name of HTTP request header.	string	Required
header_value	Value of HTTP request header Value of HTTP request header.	string	Required
type	Must be set to the value LBHttpRequestHeaderRewriteAction	LBRuleActionType	Required

LBHttpRequestMethodCondition (schema)

Condition to match method of HTTP request messages

This condition is used to match method of HTTP requests. If the method of an
HTTP request is same as the method specified in this condition, the HTTP
request match this condition. For example, if the method field is set to
GET in this condition, any HTTP request with GET method matches the
condition.

Name	Description	Type	Notes
inverse	A flag to indicate whether reverse the match result of this condition	boolean	Default: "False"
method	Type of HTTP request method	HttpRequestMethodType	Required
type	Must be set to the value LBHttpRequestMethodCondition	LBRuleConditionType	Required

LBHttpRequestUriArgumentsCondition (schema)

Condition to match URI arguments of HTTP requests

This condition is used to match URI arguments aka query string of Http
request messages, for example, in URI http://exaple.com?foo=1&bar=2, the
"foo=1&bar=2" is the query string containing URI arguments. In an URI
scheme, query string is indicated by the first question mark ("?")
character and terminated by a number sign ("#") character or by the end of
the URI.
The uri_arguments field can be specified as a regular expression(Set
match_type to REGEX). For example, "foo=(?<x>\d+)". It matches HTTP
requests whose URI arguments containing "foo", the value of foo contains
only digits. And the value of foo is captured as $x which can be used in
LBRuleAction fields which support variables.

Name	Description	Type	Notes
case_sensitive	A case sensitive flag for URI arguments comparing If true, case is significant when comparing URI arguments.	boolean	Default: "True"
inverse	A flag to indicate whether reverse the match result of this condition	boolean	Default: "False"
match_type	Match type of URI arguments	LbRuleMatchType	Default: "REGEX"
type	Must be set to the value LBHttpRequestUriArgumentsCondition	LBRuleConditionType	Required
uri_arguments	URI arguments URI arguments, aka query string of URI.	string	Required

LBHttpRequestUriCondition (schema)

Condition to match URIs of HTTP request messages

This condition is used to match URIs(Uniform Resource Identifier) of HTTP
request messages. The URI field can be specified as a regular expression.
If an HTTP request message is requesting an URI which matches specified
regular expression, it matches the condition.
The syntax of whole URI looks like this:
scheme:[//[user[:password]@]host[:port]][/path][?query][#fragment]
This condition matches only the path part of entire URI.
When match_type field is specified as REGEX, the uri field is used as a
regular expression to match URI path of HTTP requests. For example, to
match any URI that has "/image/" or "/images/", uri field can be specified
as: "/image[s]?/".
Named capturing groups can be used in the uri field to capture substrings
of matched URIs and store them in variables for use in LBRuleAction. For
example, specify uri field as:
"/news/(?<year>\d+)/(?<month>\d+)/(?<article>.*)"
If the URI path is /articles/news/2017/06/xyz.html, then substring "2017"
is captured in variable year, "06" is captured in variable month, and
"xyz.html" is captured in variable article. These variables can then
be used in an LBRuleAction field which supports variables, such as uri
field of LBHttpRequestUriRewriteAction. For example, set the uri field
of LBHttpRequestUriRewriteAction as:
"/articles/news/$year-$month-$article"
Then the URI path /articles/news/2017/06/xyz.html is rewritten to:
"/articles/news/2017-06-xyz.html"

Name	Description	Type	Notes
case_sensitive	A case sensitive flag for URI comparing If true, case is significant when comparing URI.	boolean	Default: "True"
inverse	A flag to indicate whether reverse the match result of this condition	boolean	Default: "False"
match_type	Match type of URI	LbRuleMatchType	Default: "REGEX"
type	Must be set to the value LBHttpRequestUriCondition	LBRuleConditionType	Required
uri	A string used to identify resource	string	Required

LBHttpRequestUriRewriteAction (schema)

Action to rewrite HTTP request URIs.

This action is used to rewrite URIs in matched HTTP request messages.
Specify the uri and uri_arguments fields in this condition to rewrite the
matched HTTP request message's URI and URI arguments to the new values.
Full URI scheme of HTTP messages have following syntax:
scheme:[//[user[:password]@]host[:port]][/path][?query][#fragment]
The uri field of this action is used to rewrite the /path part in above
scheme. And the uri_arguments field is used to rewrite the query part.
Captured variables and built-in variables can be used in the uri and
uri_arguments fields.
Check the example in LBRuleAction to see how to use variables in this
action.

Name	Description	Type	Notes
type	Must be set to the value LBHttpRequestUriRewriteAction	LBRuleActionType	Required
uri	URI of HTTP request URI of HTTP request.	string	Required
uri_arguments	URI arguments Query string of URI, typically contains key value pairs, for example: foo1=bar1&foo2=bar2.	string

LBHttpRequestVersionCondition (schema)

Condition to match HTTP protocol version of HTTP requests

This condition is used to match the HTTP protocol version of the HTTP
request messages.

Name	Description	Type	Notes
inverse	A flag to indicate whether reverse the match result of this condition	boolean	Default: "False"
type	Must be set to the value LBHttpRequestVersionCondition	LBRuleConditionType	Required
version	HTTP version	HttpRequestVersionType	Required

LBHttpResponseHeaderCondition (schema)

Condition to match a header field of HTTP response

This condition is used to match HTTP response messages from backend servers
by HTTP header fields. HTTP header fields are components of the header
section of HTTP request and response messages. They define the operating
parameters of an HTTP transaction. For example, Cookie, Authorization,
User-Agent, etc. One condition can be used to match one header field, to
match multiple header fields, multiple conditions must be specified.
The match_type field defines how header_value field is used to match HTTP
responses. The header_name field does not support match types.

Name	Description	Type	Notes
case_sensitive	A case sensitive flag for HTTP header value comparing If true, case is significant when comparing HTTP header value.	boolean	Default: "True"
header_name	Name of HTTP header field	string	Required
header_value	Value of HTTP header field	string	Required
inverse	A flag to indicate whether reverse the match result of this condition	boolean	Default: "False"
match_type	Match type of HTTP header value	LbRuleMatchType	Default: "REGEX"
type	Must be set to the value LBHttpResponseHeaderCondition	LBRuleConditionType	Required

LBHttpResponseHeaderDeleteAction (schema)

Action to delete HTTP response header fields

This action is used to delete header fields of HTTP response messages at
HTTP_RESPONSE_REWRITE phase. One action can be used to delete allgi headers
with same header name. To delete headers with different header names,
multiple actions must be defined.

Name	Description	Type	Notes
header_name	Name of a header field of HTTP response message Name of a header field of HTTP response message.	string	Required
type	Must be set to the value LBHttpResponseHeaderDeleteAction	LBRuleActionType	Required

LBHttpResponseHeaderRewriteAction (schema)

Action to rewrite HTTP response header fields

This action is used to rewrite header fields of HTTP response messages to
specified new values at HTTP_RESPONSE_REWRITE phase. One action can be used
to rewrite one header field. To rewrite multiple header fields, multiple
actions must be defined.
Captured variables and built-in variables can be used in the header_value
field, header_name field does not support variables.

Name	Description	Type	Notes
header_name	Name of a header field of HTTP request message Name of a header field of HTTP request message.	string	Required
header_value	Value of header field Value of header field	string	Required
type	Must be set to the value LBHttpResponseHeaderRewriteAction	LBRuleActionType	Required

LBHttpSslCondition (schema)

Condition to match SSL handshake and SSL connection

This condition is used to match SSL handshake and SSL connection at
all phases.If multiple properties are configured, the rule is considered
a match when all the configured properties are matched.

Name	Description	Type	Notes
client_certificate_issuer_dn	The issuer DN match condition of the client certificate The issuer DN match condition of the client certificate for an established SSL connection.	LBClientCertificateIssuerDnCondition
client_certificate_subject_dn	The subject DN match condition of the client certificate The subject DN match condition of the client certificate for an established SSL connection.	LBClientCertificateSubjectDnCondition
client_supported_ssl_ciphers	Cipher list which supported by client Cipher list which supported by client.	array of SslCipher
inverse	A flag to indicate whether reverse the match result of this condition	boolean	Default: "False"
session_reused	The type of SSL session reused The type of SSL session reused.	LbSslSessionReusedType	Default: "IGNORE"
type	Must be set to the value LBHttpSslCondition	LBRuleConditionType	Required
used_protocol	Protocol of an established SSL connection Protocol of an established SSL connection.	SslProtocol
used_ssl_cipher	Cipher used for an established SSL connection Cipher used for an established SSL connection.	SslCipher

LBHttpsMonitorProfile (schema)

LBMonitorProfile for active health checks over HTTPS

Active healthchecks are disabled by default and can be enabled for a
server pool by binding a health monitor to the Group through the LBRule
object. This represents active health monitoring over HTTPS. Active
healthchecks are initiated periodically, at a configurable interval, to
each member of the Group. Only if a healthcheck fails consecutively for a
specified number of times (fall_count) to a member will the member status
be marked DOWN. Once a member is DOWN, a specified number of consecutive
successful healthchecks (rise_count) will bring the member back to UP
state. After a healthcheck is initiated, if it does not complete within a
certain period, then also the healthcheck is considered to be
unsuccessful. Completing a healthcheck within timeout means establishing
a connection (TCP or SSL), if applicable, sending the request and
receiving the response, all within the configured timeout.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
fall_count	Monitor fall count for active healthchecks Only if a healthcheck fails consecutively for a specified number of times, given with fall_count, to a member will the member status be marked DOWN.	integer	Minimum: 1 Maximum: 2147483647 Default: "3"
id	Unique identifier of this resource	string	Sortable
interval	Monitor interval in seconds for active healthchecks Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group.	integer	Minimum: 1 Maximum: 2147483647 Default: "5"
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
monitor_port	Monitor port for active healthchecks Typically, monitors perform healthchecks to Group members using the member IP address and pool_port. However, in some cases, customers prefer to run healthchecks against a different port than the pool member port which handles actual application traffic. In such cases, the port to run healthchecks against can be specified in the monitor_port value. For ICMP monitor, monitor_port is not required.	int	Minimum: 0 Maximum: 65535
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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
request_body	HTTP health check request body String to send as part of HTTP health check request body. Valid only for certain HTTP methods like POST.	string
request_headers	Array of HTTP request headers Array of HTTP request headers.	array of LbHttpRequestHeader
request_method	The health check method for HTTP monitor type The health check method for HTTP monitor type.	HttpRequestMethodType	Default: "GET"
request_url	Customized HTTPS request url for active health checks For HTTPS active healthchecks, the HTTPS request url sent can be customized and can include query parameters.	string	Default: "/"
request_version	HTTP request version HTTP request version.	HttpRequestVersionType	Default: "HTTP_VERSION_1_1"
resource_type	Must be set to the value LBHttpsMonitorProfile	LBMonitorProfileType	Required
response_body	Response body to match If HTTP response body match string (regular expressions not supported) is specified (using LBHttpMonitor.response_body) then the healthcheck HTTP response body is matched against the specified string and server is considered healthy only if there is a match. If the response body string is not specified, HTTP healthcheck is considered successful if the HTTP response status code is 2xx, but it can be configured to accept other status codes as successful.	string
response_status_codes	Array of single HTTP response status codes The HTTP response status code should be a valid HTTP status code.	array of int	Maximum items: 64
rise_count	Monitor rise count for active healthchecks Once a member is DOWN, a specified number of consecutive successful healthchecks specified by rise_count will bring the member back to UP state.	integer	Minimum: 1 Maximum: 2147483647 Default: "3"
server_ssl_profile_binding	Pool side SSL binding setting The setting is used when the monitor acts as an SSL client and establishing a connection to the backend server.	LBServerSslProfileBinding
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
timeout	Monitor timeout in seconds for active healthchecks Timeout specified in seconds. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.	integer	Minimum: 1 Maximum: 2147483647 Default: "5"
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

LBIcmpMonitorProfile (schema)

LBMonitorProfile for active health checks over ICMP

Active healthchecks are disabled by default and can be enabled for a
server pool by binding a health monitor to the Group through the LBRule
object. This represents active health monitoring over ICMP.
Active healthchecks are initiated periodically, at a configurable
interval, to each member of the Group. Only if a healthcheck fails
consecutively for a specified number of times (fall_count) to a member will
the member status be marked DOWN. Once a member is DOWN, a specified
number of consecutive successful healt hchecks (rise_count) will bring the
member back to UP state. After a healthcheck is initiated, if it does not
complete within a certain period, then also the healthcheck is considered
to be unsuccessful. Completing a healthcheck within timeout means establishing
a connection (TCP or SSL), if applicable, sending the request and
receiving the response, all within the configured timeout.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
data_length	The data size (in byte) of the ICMP healthcheck packet	integer	Minimum: 0 Maximum: 65507 Default: "56"
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
fall_count	Monitor fall count for active healthchecks Only if a healthcheck fails consecutively for a specified number of times, given with fall_count, to a member will the member status be marked DOWN.	integer	Minimum: 1 Maximum: 2147483647 Default: "3"
id	Unique identifier of this resource	string	Sortable
interval	Monitor interval in seconds for active healthchecks Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group.	integer	Minimum: 1 Maximum: 2147483647 Default: "5"
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
monitor_port	Monitor port for active healthchecks Typically, monitors perform healthchecks to Group members using the member IP address and pool_port. However, in some cases, customers prefer to run healthchecks against a different port than the pool member port which handles actual application traffic. In such cases, the port to run healthchecks against can be specified in the monitor_port value. For ICMP monitor, monitor_port is not required.	int	Minimum: 0 Maximum: 65535
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 LBIcmpMonitorProfile	LBMonitorProfileType	Required
rise_count	Monitor rise count for active healthchecks Once a member is DOWN, a specified number of consecutive successful healthchecks specified by rise_count will bring the member back to UP state.	integer	Minimum: 1 Maximum: 2147483647 Default: "3"
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
timeout	Monitor timeout in seconds for active healthchecks Timeout specified in seconds. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.	integer	Minimum: 1 Maximum: 2147483647 Default: "5"
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

LBIpHeaderCondition (schema)

Condition to match IP header fields

This condition is used to match IP header fields of HTTP messages.
Either source_address or group_id should be specified.

Name	Description	Type	Notes
group_path	Grouping object path Source IP address of HTTP message should match IP addresses which are configured in Group in order to perform actions.	string
inverse	A flag to indicate whether reverse the match result of this condition	boolean	Default: "False"
source_address	Source IP address of HTTP message Source IP address of HTTP message. IP Address can be expressed as a single IP address like 10.1.1.1, or a range of IP addresses like 10.1.1.101-10.1.1.160. Both IPv4 and IPv6 addresses are supported.	IPElement
type	Must be set to the value LBIpHeaderCondition	LBRuleConditionType	Required

LBJwtAuthAction (schema)

Action to control access using JWT authentication

This action is used to control access to backend server resources using
JSON Web Token(JWT) authentication. The JWT authentication is done before
any HTTP manipulation if the HTTP request matches the given condition in
LBRule. Any verification failed, the HTTP process will be terminated, and
HTTP response with 401 status code and WWW-Authentication header will be
returned to client.

Name	Description	Type	Notes
key	LBJwtKey used for verifying the signature of JWT token	LBJwtKey (Abstract type: pass one of the following concrete types) LBJwtCertificateKey LBJwtPublicKey LBJwtSymmetricKey
pass_jwt_to_pool	Whether to pass the JWT to backend server or remove it Specify whether to pass the JWT to backend server or remove it. By default, it is false which means will not pass the JWT to backend servers.	boolean	Default: "False"
realm	JWT realm A description of the protected area. If no realm is specified, clients often display a formatted hostname instead. The configured realm is returned when client request is rejected with 401 http status. In the response, it will be "WWW-Authentication: Bearer realm=<realm>".	string
tokens	JWT tokens JWT is an open standard that defines a compact and self-contained way for securely transmitting information between parties as a JSON object. Load balancer will search for every specified tokens one by one for the jwt message until found. This parameter is optional. In case not found or this field is not configured, load balancer searches the Bearer header by default in the http request "Authorization: Bearer <token>".	array of string
type	Must be set to the value LBJwtAuthAction	LBRuleActionType	Required

LBJwtCertificateKey (schema)

Specifies certificate used to verify the signature of JWT tokens

The key is used to specify certificate which is used to verify the
signature of JWT tokens.

Name	Description	Type	Notes
certificate_path	Certificate identifier	string	Required
type	Must be set to the value LBJwtCertificateKey	LBJwtKeyType	Required

LBJwtKey (schema)

Load balancer JWT key

LBJwtKey specifies the symmetric key or asymmetric public key used to
decrypt the data in JWT.
This is an abstract type. Concrete child types:
LBJwtCertificateKey
LBJwtPublicKey
LBJwtSymmetricKey

Name	Description	Type	Notes
type	Type of load balancer JWT key The property is used to identify JWT key type.	LBJwtKeyType	Required

LBJwtKeyType (schema)

Type of load balancer JWT key

It is used to identify JWT key type.

Name	Description	Type	Notes
LBJwtKeyType	Type of load balancer JWT key It is used to identify JWT key type.	string	Enum: LBJwtCertificateKey, LBJwtSymmetricKey, LBJwtPublicKey

LBJwtPublicKey (schema)

Specifies public key content used to verify the signature of JWT tokens

The key is used to specify the public key content which is used to verify
the signature of JWT tokens.

Name	Description	Type	Notes
public_key_content	Content of public key	string	Required
type	Must be set to the value LBJwtPublicKey	LBJwtKeyType	Required

LBJwtSymmetricKey (schema)

Specifies the symmetric key used to verify the signature of JWT tokens

The key is used to specify the symmetric key which is used to verify the
signature of JWT tokens.

Name	Description	Type	Notes
type	Must be set to the value LBJwtSymmetricKey	LBJwtKeyType	Required

LBMonitorProfile (schema)

This is an abstract type. Concrete child types:
LBActiveMonitor
LBHttpMonitorProfile
LBHttpsMonitorProfile
LBIcmpMonitorProfile
LBPassiveMonitorProfile
LBTcpMonitorProfile
LBUdpMonitorProfile

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 LBMonitorProfile	LBMonitorProfileType	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

LBMonitorProfileType (schema)

Monitor type

There are two types of healthchecks: active and passive.
Passive healthchecks depend on failures in actual client traffic (e.g. RST
from server in response to a client connection) to detect that the server
or the application is down.
In case of active healthchecks, load balancer itself initiates new
connections (or sends ICMP ping) to the servers periodically to check their
health, completely independent of any data traffic.
Currently, active health monitors are supported for HTTP, HTTPS, TCP, UDP
and ICMP protocols.

Name	Description	Type	Notes
LBMonitorProfileType	Monitor type There are two types of healthchecks: active and passive. Passive healthchecks depend on failures in actual client traffic (e.g. RST from server in response to a client connection) to detect that the server or the application is down. In case of active healthchecks, load balancer itself initiates new connections (or sends ICMP ping) to the servers periodically to check their health, completely independent of any data traffic. Currently, active health monitors are supported for HTTP, HTTPS, TCP, UDP and ICMP protocols.	string	Enum: LBTcpMonitorProfile, LBUdpMonitorProfile, LBIcmpMonitorProfile, LBHttpMonitorProfile, LBHttpsMonitorProfile, LBPassiveMonitorProfile

LBPassiveMonitorProfile (schema)

Base class for each type of active LBMonitorProfile

The passive type of LBMonitorProfile.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
max_fails	Number of consecutive connection failures When the consecutive failures reach this value, then the member is considered temporarily unavailable for a configurable period	integer	Minimum: 1 Maximum: 2147483647 Default: "5"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 LBPassiveMonitorProfile	LBMonitorProfileType	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
timeout	Timeout in seconds before it is selected again for a new connection After this timeout period, the member is tried again for a new connection to see if it is available.	integer	Minimum: 1 Maximum: 2147483647 Default: "5"
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

LBPersistenceCookieTime (schema)

Persistence cookie time

Persistence cookie time.

Name	Description	Type	Notes
cookie_max_idle	Persistence cookie max idle time in seconds HTTP cookie max-age to expire cookie, only available for insert mode.	integer	Required Minimum: 1 Maximum: 2147483647
type	Must be set to the value LBPersistenceCookieTime	LBCookieTimeType	Required

LBPersistenceProfile (schema)

Contains the information related to load balancer persistence options

Some applications maintain state and require all relevant connections
to be sent to the same server as the application state is not
synchronized among servers. Persistence is enabled on a
LBVirtualServer by binding a persistence profile to it.
LBGenericPersistenceProfile cannot be attached to LBVirtualServer
directly, it can be specified in LBVariablePersistenceOnAction or
LBVariablePersistenceLearnAction in LBRule. If a user attaches a
LBGenericPersistenceProfile directly to a virtual server, the operation
is rejected.
This is an abstract type. Concrete child types:
LBCookiePersistenceProfile
LBGenericPersistenceProfile
LBSourceIpPersistenceProfile

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
persistence_shared	Persistence shared across LBVirtualServers Persistence shared setting indicates that all LBVirtualServers that consume this LBPersistenceProfile should share the same persistence mechanism when enabled. Meaning, persistence entries of a client accessing one virtual server will also affect the same client's connections to a different virtual server. For example, say there are two virtual servers vip-ip1:80 and vip-ip1:8080 bound to the same Group g1 consisting of two servers (s11:80 and s12:80). By default, each virtual server will have its own persistence table or cookie. So, in the earlier example, there will be two tables (vip-ip1:80, p1) and (vip-ip1:8080, p1) or cookies. So, if a client connects to vip1:80 and later connects to vip1:8080, the second connection may be sent to a different server than the first. When persistence_shared is enabled, then the second connection will always connect to the same server as the original connection. For COOKIE persistence type, the same cookie will be shared by multiple virtual servers. For SOURCE_IP persistence type, the persistence table will be shared across virtual servers. For GENERIC persistence type, the persistence table will be shared across virtual servers which consume the same persistence profile in LBRule actions.	boolean	Default: "False"
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value LBPersistenceProfile	string	Required Enum: LBSourceIpPersistenceProfile, LBCookiePersistenceProfile, LBGenericPersistenceProfile
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

LBPool (schema)

Defining access a Group from a LBVirtualServer and binding to LBMonitorProfile

Defining access of a Group from a LBVirtualServer and binding to
LBMonitorProfile.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
active_monitor_paths	Active monitor path list In case of active healthchecks, load balancer itself initiates new connections (or sends ICMP ping) to the servers periodically to check their health, completely independent of any data traffic. Active healthchecks are disabled by default and can be enabled for a server pool by binding a health monitor to the pool. If multiple active monitors are configured, the pool member status is UP only when the health check status for all the monitors are UP.	array of string
algorithm	Load balancing algorithm Load Balancing algorithm chooses a server for each new connection by going through the list of servers in the pool. Currently, following load balancing algorithms are supported with ROUND_ROBIN as the default. ROUND_ROBIN means that a server is selected in a round-robin fashion. The weight would be ignored even if it is configured. WEIGHTED_ROUND_ROBIN means that a server is selected in a weighted round-robin fashion. Default weight of 1 is used if weight is not configured. LEAST_CONNECTION means that a server is selected when it has the least number of connections. The weight would be ignored even if it is configured. Slow start would be enabled by default. WEIGHTED_LEAST_CONNECTION means that a server is selected in a weighted least connection fashion. Default weight of 1 is used if weight is not configured. Slow start would be enabled by default. IP_HASH means that consistent hash is performed on the source IP address of the incoming connection. This ensures that the same client IP address will always reach the same server as long as no server goes down or up. It may be used on the Internet to provide a best-effort stickiness to clients which refuse session cookies.	string	Enum: ROUND_ROBIN, WEIGHTED_ROUND_ROBIN, LEAST_CONNECTION, WEIGHTED_LEAST_CONNECTION, IP_HASH Default: "ROUND_ROBIN"
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
member_group	Load balancer member setting with grouping object Load balancer pool support grouping object as dynamic pool members. When member group is defined, members setting should not be specified.	LBPoolMemberGroup
members	Load balancer pool members Server pool consists of one or more pool members. Each pool member is identified, typically, by an IP address and a port.	array of LBPoolMember
min_active_members	Minimum number of active pool members to consider pool as active A pool is considered active if there are at least certain minimum number of members.	integer	Minimum: 1 Maximum: 2147483647 Default: "1"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
passive_monitor_path	Passive monitor path Passive healthchecks are disabled by default and can be enabled by attaching a passive health monitor to a server pool. Each time a client connection to a pool member fails, its failed count is incremented. For pools bound to L7 virtual servers, a connection is considered to be failed and failed count is incremented if any TCP connection errors (e.g. TCP RST or failure to send data) or SSL handshake failures occur. For pools bound to L4 virtual servers, if no response is received to a TCP SYN sent to the pool member or if a TCP RST is received in response to a TCP SYN, then the pool member is considered to have failed and the failed count is incremented.	string
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 LBPool	string
snat_translation	Snat translation configuration Depending on the topology, Source NAT (SNAT) may be required to ensure traffic from the server destined to the client is received by the load balancer. SNAT can be enabled per pool. If SNAT is not enabled for a pool, then load balancer uses the client IP and port (spoofing) while establishing connections to the servers. This is referred to as no-SNAT or TRANSPARENT mode. By default Source NAT is enabled as LBSnatAutoMap.	LBSnatTranslation (Abstract type: pass one of the following concrete types) LBSnatAutoMap LBSnatDisabled LBSnatIpPool
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
tcp_multiplexing_enabled	TCP multiplexing enable flag TCP multiplexing allows the same TCP connection between load balancer and the backend server to be used for sending multiple client requests from different client TCP connections.	boolean	Default: "False"
tcp_multiplexing_number	Maximum number of TCP connections for multiplexing The maximum number of TCP connections per pool that are idly kept alive for sending future client requests.	integer	Minimum: 0 Maximum: 2147483647 Default: "6"
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

LBPoolMember (schema)

Pool member

Pool member.

Name	Description	Type	Notes
admin_state	Member admin state Member admin state.	PoolMemberAdminStateType	Default: "ENABLED"
backup_member	Determine whether the pool member is for backup usage Backup servers are typically configured with a sorry page indicating to the user that the application is currently unavailable. While the pool is active (a specified minimum number of pool members are active) BACKUP members are skipped during server selection. When the pool is inactive, incoming connections are sent to only the BACKUP member(s).	boolean	Default: "False"
display_name	Pool member name Pool member name.	string
ip_address	Pool member IP address Pool member IP address.	IPAddress	Required
max_concurrent_connections	Maximum concurrent connection number To ensure members are not overloaded, connections to a member can be capped by the load balancer. When a member reaches this limit, it is skipped during server selection. If it is not specified, it means that connections are unlimited.	integer	Minimum: 1 Maximum: 2147483647
port	Pool member port number If port is specified, all connections will be sent to this port. Only single port is supported. If unset, the same port the client connected to will be used, it could be overrode by default_pool_member_port setting in virtual server. The port should not specified for port range case.	PortElement
weight	Pool member weight Pool member weight is used for WEIGHTED_ROUND_ROBIN balancing algorithm. The weight value would be ignored in other algorithms.	integer	Minimum: 1 Maximum: 256 Default: "1"

LBPoolMemberGroup (schema)

Pool member group

Pool member group.

Name	Description	Type	Notes
customized_members	List of customized pool member settings The list is used to show the customized pool member settings. User can only user pool member action API to update the admin state for a specific IP address.	array of PoolMemberSetting
group_path	Grouping object path Load balancer pool support Group as dynamic pool members. The IP list of the Group would be used as pool member IP setting.	string	Required
ip_revision_filter	Filter of ipv4 or ipv6 address of grouping object IP list Ip revision filter is used to filter IPv4 or IPv6 addresses from the grouping object. If the filter is not specified, both IPv4 and IPv6 addresses would be used as server IPs. The link local and loopback addresses would be always filtered out.	string	Enum: IPV4, IPV6, IPV4_IPV6 Default: "IPV4"
max_ip_list_size	Maximum number of grouping object IP address list The size is used to define the maximum number of grouping object IP address list. These IP addresses would be used as pool members. If the grouping object includes more than certain number of IP addresses, the redundant parts would be ignored and those IP addresses would not be treated as pool members. If the size is not specified, one member is budgeted for this dynamic pool so that the pool has at least one member even if some other dynamic pools grow beyond the capacity of load balancer service. Other members are picked according to available dynamic capacity. The unused members would be set to DISABLED so that the load balancer system itself is not overloaded during runtime.	integer	Minimum: 0 Maximum: 2147483647
port	Pool member port for all IP addresses of the grouping object If port is specified, all connections will be sent to this port. If unset, the same port the client connected to will be used, it could be overridden by default_pool_member_ports setting in virtual server. The port should not specified for multiple ports case.	int	Minimum: 1 Maximum: 65535

LBRule (schema)

Binding of a LBPool and Group to a LBVirtualServer

Binding of a LBPool and Group to a LBVirtualServer
used to route application traffic passing through load balancers.
LBRule uses match conditions to match application traffic passing
through a LBVirtualServer using HTTP or HTTPS. Can bind
multiple LBVirtualServers to a Group. Each LBRule
consists of two optional match conditions, each match contidion defines a
criterion for application traffic. If no match conditions are
specified, then the LBRule will always match and it is used
typically to define default rules. If more than one match condition is
specified, then matching strategy determines if all conditions should
match or any one condition should match for the LBRule to be
considered a match. A match indicates that the LBVirtualServer
should route the request to the Group (parent of LBRule).

Name	Description	Type	Notes
actions	Actions to be executed A list of actions to be executed at specified phase when load balancer rule matches. The actions are used to manipulate application traffic, such as rewrite URI of HTTP messages, redirect HTTP messages, etc.	array of LBRuleAction (Abstract type: pass one of the following concrete types) LBConnectionDropAction LBHttpRedirectAction LBHttpRejectAction LBHttpRequestHeaderDeleteAction LBHttpRequestHeaderRewriteAction LBHttpRequestUriRewriteAction LBHttpResponseHeaderDeleteAction LBHttpResponseHeaderRewriteAction LBJwtAuthAction LBSelectPoolAction LBSslModeSelectionAction LBVariableAssignmentAction LBVariablePersistenceLearnAction LBVariablePersistenceOnAction	Required Maximum items: 60
display_name	Display name for LBRule A display name useful for identifying an LBRule.	string
match_conditions	Conditions to match application traffic A list of match conditions used to match application traffic. Multiple match conditions can be specified in one load balancer rule, each match condition defines a criterion to match application traffic. If no match conditions are specified, then the load balancer rule will always match and it is used typically to define default rules. If more than one match condition is specified, then match strategy determines if all conditions should match or any one condition should match for the load balancer rule to considered a match.	array of LBRuleCondition (Abstract type: pass one of the following concrete types) LBHttpRequestBodyCondition LBHttpRequestCookieCondition LBHttpRequestHeaderCondition LBHttpRequestMethodCondition LBHttpRequestUriArgumentsCondition LBHttpRequestUriCondition LBHttpRequestVersionCondition LBHttpResponseHeaderCondition LBHttpSslCondition LBIpHeaderCondition LBSslSniCondition LBTcpHeaderCondition LBVariableCondition	Maximum items: 60
match_strategy	Match strategy for determining match of multiple conditions If more than one match condition is specified, then matching strategy determines if all conditions should match or any one condition should match for the LB Rule to be considered a match. - ALL indicates that both host_match and path_match must match for this LBRule to be considered a match. - ANY indicates that either host_match or patch match may match for this LBRule to be considered a match.	string	Enum: ALL, ANY Default: "ANY"
phase	Load balancer processing phase Each load balancer rule is used at a specific phase of load balancer processing. Currently five phases are supported, HTTP_REQUEST_REWRITE, HTTP_FORWARDING, HTTP_RESPONSE_REWRITE, HTTP_ACCESS and TRANSPORT. When an HTTP request message is received by load balancer, all HTTP_REQUEST_REWRITE rules, if present are executed in the order they are applied to virtual server. And then if HTTP_FORWARDING rules present, only first matching rule's action is executed, remaining rules are not checked. HTTP_FORWARDING rules can have only one action. If the request is forwarded to a backend server and the response goes back to load balancer, all HTTP_RESPONSE_REWRITE rules, if present, are executed in the order they are applied to the virtual server. In HTTP_ACCESS phase, user can define action to control access using JWT authentication. In TRANSPORT phase, user can define the condition to match SNI in TLS client hello and define the action to do SSL end-to-end, SSL offloading or SSL passthrough using a specific load balancer server pool.	string	Enum: HTTP_REQUEST_REWRITE, HTTP_FORWARDING, HTTP_RESPONSE_REWRITE, HTTP_ACCESS, TRANSPORT Default: "HTTP_FORWARDING"

LBRuleAction (schema)

Load balancer rule action

Load balancer rule actions are used to manipulate application traffic.
Currently load balancer rules can be used at three load balancer processing
phases. Each phase has its own supported type of actions.
Supported actions in HTTP_REQUST_REWRITE phase are:
LBHttpRequestUriRewriteAction
LBHttpRequestHeaderRewriteAction
LBHttpRequestHeaderDeleteAction
LBVariableAssignmentAction
Supported actions in HTTP_FORWARDING phase are:
LBHttpRejectAction
LBHttpRedirectAction
LBSelectPoolAction
LBVariablePersistenceOnAction
LBConnectionDropAction
Supported action in HTTP_RESPONSE_REWRITE phase is:
LBHttpResponseHeaderRewriteAction
LBHttpResponseHeaderDeleteAction
LBVariablePersistenceLearnAction
Supported action in HTTP_ACCESS phase is:
LBJwtAuthAction
LBConnectionDropAction
LBVariableAssignmentAction
Supported action in TRANSPORT phase is:
LBSslModeSelectionAction
LBSelectPoolAction

If the match type of an LBRuleCondition field is specified as REGEX and
named capturing groups are used in the specified regular expression. The
groups can be used as variables in LBRuleAction fields.
For example, define a rule with LBHttpRequestUriCondition as match
condition and LBHttpRequestUriRewriteAction as action. Set match_type field
of LBHttpRequestUriCondition to REGEX, and set uri field to
"/news/(?<year>\d+)/(?<month>\d+)/(?<article>.*)".
Set uri field of LBHttpRequestUriRewriteAction to:
"/news/$year-$month/$article"
In uri field of LBHttpRequestUriCondition, the (?<year>\d+),
(?<month>\d+) and (?<article>.*) are named capturing groups,
they define variables named $year, $month and $article respectively. The
defined variables are used in LBHttpRequestUriRewriteAction.
For a matched HTTP request with URI "/news/2017/06/xyz.html", the substring
"2017" is captured in variable $year, "06" is captured in variable $month,
and "xyz.html" is captured in variable $article. The
LBHttpRequestUriRewriteAction will rewrite the URI to:
"/news/2017-06/xyz.html"
A set of built-in variables can be used in LBRuleAction as well. The name
of built-in variables start with underscore, the name of user defined
variables is not allowed to start with underscore.
Following are some of the built-in variables:
$_scheme: Reference the scheme part of matched HTTP messages, could be
"http" or "https".
$_host: Host of matched HTTP messages, for example "www.example.com".
$_server_port: Port part of URI, it is also the port of the server which
accepted a request. Default port is 80 for http and 443 for https.
$_uri: The URI path, for example "/products/sample.html".
$_request_uri: Full original request URI with arguments, for example,
"/products/sample.html?a=b&c=d".
$_args: URI arguments, for instance "a=b&c=d"
$_is_args: "?" if a request has URI arguments, or an empty string
otherwise.
For the full list of built-in variables, please reference the NSX-T
Administrator's Guide.
This is an abstract type. Concrete child types:
LBConnectionDropAction
LBHttpRedirectAction
LBHttpRejectAction
LBHttpRequestHeaderDeleteAction
LBHttpRequestHeaderRewriteAction
LBHttpRequestUriRewriteAction
LBHttpResponseHeaderDeleteAction
LBHttpResponseHeaderRewriteAction
LBJwtAuthAction
LBSelectPoolAction
LBSslModeSelectionAction
LBVariableAssignmentAction
LBVariablePersistenceLearnAction
LBVariablePersistenceOnAction

Name	Description	Type	Notes
type	Type of load balancer rule action The property identifies the load balancer rule action type.	LBRuleActionType	Required

LBRuleActionType (schema)

Types of load balancer rule actions

Types of load balancer rule actions.

Name	Description	Type	Notes
LBRuleActionType	Types of load balancer rule actions Types of load balancer rule actions.	string	Enum: LBSelectPoolAction, LBHttpRequestUriRewriteAction, LBHttpRequestHeaderRewriteAction, LBHttpRejectAction, LBHttpRedirectAction, LBHttpResponseHeaderRewriteAction, LBHttpRequestHeaderDeleteAction, LBHttpResponseHeaderDeleteAction, LBVariableAssignmentAction, LBVariablePersistenceOnAction, LBVariablePersistenceLearnAction, LBJwtAuthAction, LBSslModeSelectionAction, LBConnectionDropAction

LBRuleCondition (schema)

Match condition of load balancer rule

Match conditions are used to match application traffic passing through
load balancers. Multiple match conditions can be specified in one load
balancer rule, each match condition defines a criterion for application
traffic.
If inverse field is set to true, the match result of the condition is
inverted.
If more than one match condition is specified, match strategy determines
if all conditions should match or any one condition should match for the
load balancer rule to be considered a match.
Currently only HTTP messages are supported by load balancer rules.
Each load balancer rule is used at a specific phase of load balancer
processing. Currently three phases are supported, HTTP_REQUEST_REWRITE,
HTTP_FORWARDING and HTTP_RESPONSE_REWRITE.
Each phase supports certain types of match conditions, supported match
conditions in HTTP_REQUEST_REWRITE phase are:
LBHttpRequestMethodCondition
LBHttpRequestUriCondition
LBHttpRequestUriArgumentsCondition
LBHttpRequestVersionCondition
LBHttpRequestHeaderCondition
LBHttpRequestCookieCondition
LBHttpRequestBodyCondition
LBTcpHeaderCondition
LBIpHeaderCondition
LBVariableCondition
LBHttpSslCondition
Supported match conditions in HTTP_FORWARDING phase are:
LBHttpRequestMethodCondition
LBHttpRequestUriCondition
LBHttpRequestUriArgumentsCondition
LBHttpRequestVersionCondition
LBHttpRequestHeaderCondition
LBHttpRequestCookieCondition
LBHttpRequestBodyCondition
LBTcpHeaderCondition
LBIpHeaderCondition
LBVariableCondition
LBHttpSslCondition
LBSslSniCondition
Supported match conditions in HTTP_RESPONSE_REWRITE phase are:
LBHttpResponseHeaderCondition
LBHttpRequestMethodCondition
LBHttpRequestUriCondition
LBHttpRequestUriArgumentsCondition
LBHttpRequestVersionCondition
LBHttpRequestHeaderCondition
LBHttpRequestCookieCondition
LBTcpHeaderCondition
LBIpHeaderCondition
LBVariableCondition
LBHttpSslCondition
Supported match condition in HTTP_ACCESS phase is:
LBHttpRequestMethodCondition
LBHttpRequestUriCondition
LBHttpRequestUriArgumentsCondition
LBHttpRequestVersionCondition
LBHttpRequestHeaderCondition
LBHttpRequestCookieCondition
LBHttpRequestBodyCondition
LBTcpHeaderCondition
LBIpHeaderCondition
LBVariableCondition
LBHttpSslCondition
Supported match condition in TRANSPORT phase is:
LBSslSniCondition
This is an abstract type. Concrete child types:
LBHttpRequestBodyCondition
LBHttpRequestCookieCondition
LBHttpRequestHeaderCondition
LBHttpRequestMethodCondition
LBHttpRequestUriArgumentsCondition
LBHttpRequestUriCondition
LBHttpRequestVersionCondition
LBHttpResponseHeaderCondition
LBHttpSslCondition
LBIpHeaderCondition
LBSslSniCondition
LBTcpHeaderCondition
LBVariableCondition

Name	Description	Type	Notes
inverse	A flag to indicate whether reverse the match result of this condition	boolean	Default: "False"
type	Type of load balancer rule condition	LBRuleConditionType	Required

LBRuleConditionType (schema)

Type of load balancer rule match condition

Type of load balancer rule match condition.

Name	Description	Type	Notes
LBRuleConditionType	Type of load balancer rule match condition Type of load balancer rule match condition.	string	Enum: LBHttpRequestUriCondition, LBHttpRequestHeaderCondition, LBHttpRequestMethodCondition, LBHttpRequestUriArgumentsCondition, LBHttpRequestVersionCondition, LBHttpRequestCookieCondition, LBHttpRequestBodyCondition, LBHttpResponseHeaderCondition, LBTcpHeaderCondition, LBIpHeaderCondition, LBVariableCondition, LBHttpSslCondition, LBSslSniCondition

LBSelectPoolAction (schema)

Action to select a pool for HTTP request messages

This action is used to select a pool for matched HTTP request messages. The
pool is specified by path. The matched HTTP request messages are forwarded
to the specified pool.

Name	Description	Type	Notes
pool_id	Path of load balancer pool Path of load balancer pool.	string	Required
type	Must be set to the value LBSelectPoolAction	LBRuleActionType	Required

LBServerAuthType (schema)

server authentication mode

Server authentication could be AUTO_APPLY, REQUIRED or IGNORE, it is used to
specify if the server certificate presented to the load balancer during
handshake should be actually validated or not.
Validation is automatic by default when server_auth_ca_certificate_paths are
configured and IGNORED when they are not configured.
If validation is REQUIRED, then to be accepted, server certificate must be
signed by one of the trusted CAs whose self signed certificates are
specified in the same server-side SSL profile binding.

Name	Description	Type	Notes
LBServerAuthType	server authentication mode Server authentication could be AUTO_APPLY, REQUIRED or IGNORE, it is used to specify if the server certificate presented to the load balancer during handshake should be actually validated or not. Validation is automatic by default when server_auth_ca_certificate_paths are configured and IGNORED when they are not configured. If validation is REQUIRED, then to be accepted, server certificate must be signed by one of the trusted CAs whose self signed certificates are specified in the same server-side SSL profile binding.	string	Enum: REQUIRED, IGNORE, AUTO_APPLY

LBServerSslProfile (schema)

Server SSL profile

Server SSL profile.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
cipher_group_label	Label of cipher group It is a label of cipher group which is mostly consumed by GUI.	SslCipherGroup
ciphers	Supported SSL cipher list to client side Supported SSL cipher list to client side.	array of SslCipher
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
is_fips	FIPS compliance of ciphers and protocols This flag is set to true when all the ciphers and protocols are FIPS compliant. It is set to false when one of the ciphers or protocols are not FIPS compliant.	boolean	Readonly
is_secure	Secure/Insecure SSL profile flag This flag is set to true when all the ciphers and protocols are secure. It is set to false when one of the ciphers or protocols is insecure.	boolean	Readonly
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
protocols	Supported SSL protocol list to client side SSL versions TLS1.1 and TLS1.2 are supported and enabled by default. SSLv2, SSLv3, and TLS1.0 are supported, but disabled by default.	array of SslProtocol
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value LBServerSslProfile	string
session_cache_enabled	Session cache enable/disable falg SSL session caching allows SSL client and server to reuse previously negotiated security parameters avoiding the expensive public key operation during handshake.	boolean	Default: "True"
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

LBServerSslProfileBinding (schema)

Server SSL profile binding

Server SSL profile binding.

Name	Description	Type	Notes
certificate_chain_depth	The maximum traversal depth of server certificate chain Authentication depth is used to set the verification depth in the server certificates chain.	integer	Minimum: 1 Maximum: 2147483647 Default: "3"
client_certificate_path	Client certificate path To support client authentication (load balancer acting as a client authenticating to the backend server), client certificate can be specified in the server-side SSL profile binding	string
server_auth	Server authentication mode Server authentication mode.	LBServerAuthType	Default: "AUTO_APPLY"
server_auth_ca_paths	CA path list to verify server certificate If server auth type is REQUIRED, server certificate must be signed by one of the trusted Certificate Authorities (CAs), also referred to as root CAs, whose self signed certificates are specified.	array of string
server_auth_crl_paths	CRL path list to verify server certificate A Certificate Revocation List (CRL) can be specified in the server-side SSL profile binding to disallow compromised server certificates.	array of string
ssl_profile_path	Server SSL profile path Server SSL profile defines reusable, application-independent server side SSL properties.	string

LBService (schema)

Loadbalancer Service

Loadbalancer Service.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
access_log_enabled	Flag to enable access log	boolean	Deprecated
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
connectivity_path	The connectivity target used to instantiate the LBService LBS could be instantiated (or created) on the Tier-1, etc. For now, only the Tier-1 object is supported.	string
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
enabled	Flag to enable the load balancer service Flag to enable the load balancer service.	boolean	Default: "True"
error_log_level	Error log level of load balancer service Load balancer engine writes information about encountered issues of different severity levels to the error log. This setting is used to define the severity level of the error log.	LbLogLevel	Default: "INFO"
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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
relax_scale_validation	Whether scale validation is relaxed If relax_scale_validation is true, the scale validations for virtual servers/pools/pool members/rules are relaxed for load balancer service. When load balancer service is deployed on edge nodes, the scale of virtual servers/pools/pool members for the load balancer service should not exceed the scale number of the largest load balancer size which could be configured on a certain edge form factor. For example, the largest load balancer size supported on a MEDIUM edge node is MEDIUM. So one SMALL load balancer deployed on MEDIUM edge nodes can support the scale number of MEDIUM load balancer. It is not recommended to enable active monitors if relax_scale_validation is true due to performance consideration. If relax_scale_validation is false, scale numbers should be validated for load balancer service.	boolean	Default: "False"
resource_type	Must be set to the value LBService	string
size	Load balancer service size Load balancer service size.	LbServiceSize	Default: "SMALL"
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

LBSessionCookieTime (schema)

Session cookie time

Session cookie time.

Name	Description	Type	Notes
cookie_max_idle	Session cookie max idle time in seconds Instead of using HTTP Cookie max-age and relying on client to expire the cookie, max idle time and/or max lifetime of the cookie can be used. Max idle time, if configured, specifies the maximum interval the cookie is valid for from the last time it was seen in a request. It is available for insert mode.	integer	Minimum: 1 Maximum: 2147483647
cookie_max_life	Session cookie max lifetime in seconds Max life time, if configured, specifies the maximum interval the cookie is valid for from the first time the cookie was seen in a request. It is available for insert mode.	integer	Minimum: 1 Maximum: 2147483647
type	Must be set to the value LBSessionCookieTime	LBCookieTimeType	Required

LBSnatAutoMap (schema)

Snat auto map

Snat auto map.

Name	Description	Type	Notes
type	Must be set to the value LBSnatAutoMap	LBSnatTranslationType	Required

LBSnatDisabled (schema)

Snat disabled

Snat disabled.

Name	Description	Type	Notes
type	Must be set to the value LBSnatDisabled	LBSnatTranslationType	Required

LBSnatIpElement (schema)

Snat Ip element

Snat Ip element.

Name	Description	Type	Notes
ip_address	Ip address or ip range Ip address or ip range such as 1.1.1.1 or 1.1.1.101-1.1.1.160.	IPElement	Required
prefix_length	Subnet prefix length Subnet prefix length should be not specified if there is only one single IP address or IP range.	integer

LBSnatIpPool (schema)

Snat Ip pool

Snat Ip pool.

Name	Description	Type	Notes
ip_addresses	List of Ip address or ip range If an IP range is specified, the range may contain no more than 64 IP addresses.	array of LBSnatIpElement	Required Maximum items: 64
type	Must be set to the value LBSnatIpPool	LBSnatTranslationType	Required

LBSnatTranslation (schema)

Snat Translation

Snat Translation. This is an abstract type. Concrete child types:
LBSnatAutoMap
LBSnatDisabled
LBSnatIpPool

Name	Description	Type	Notes
type	Snat translation type Snat translation type.	LBSnatTranslationType	Required

LBSnatTranslationType (schema)

Snat translation type

Load balancers may need to perform SNAT to ensure reverse traffic from
the server can be received and processed by them.
There are three modes:
LBSnatAutoMap uses the load balancer interface IP and an
ephemeral port as the source IP and port of the server side connection.
LBSnatIpPool allows user to specify one or more IP addresses
along with their subnet masks that should be used for SNAT while
connecting to any of the servers in the pool.
LBSnatDisabled disables Source NAT. This is referred to as no-SNAT
or TRANSPARENT mode.

Name	Description	Type	Notes
LBSnatTranslationType	Snat translation type Load balancers may need to perform SNAT to ensure reverse traffic from the server can be received and processed by them. There are three modes: LBSnatAutoMap uses the load balancer interface IP and an ephemeral port as the source IP and port of the server side connection. LBSnatIpPool allows user to specify one or more IP addresses along with their subnet masks that should be used for SNAT while connecting to any of the servers in the pool. LBSnatDisabled disables Source NAT. This is referred to as no-SNAT or TRANSPARENT mode.	string	Enum: LBSnatAutoMap, LBSnatIpPool, LBSnatDisabled

LBSourceIpPersistenceProfile (schema)

LBPersistenceProflie using SourceIP

Some applications maintain state and require all relevant connections
to be sent to the same server as the application state is not
synchronized among servers. Persistence is enabled on a
LBVirtualServer by binding a persistence profile to it.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
ha_persistence_mirroring_enabled	Mirroring enabled flag to synchronize persistence entries Persistence entries are not synchronized to the HA peer by default.	boolean	Default: "False"
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
persistence_shared	Persistence shared across LBVirtualServers Persistence shared setting indicates that all LBVirtualServers that consume this LBPersistenceProfile should share the same persistence mechanism when enabled. Meaning, persistence entries of a client accessing one virtual server will also affect the same client's connections to a different virtual server. For example, say there are two virtual servers vip-ip1:80 and vip-ip1:8080 bound to the same Group g1 consisting of two servers (s11:80 and s12:80). By default, each virtual server will have its own persistence table or cookie. So, in the earlier example, there will be two tables (vip-ip1:80, p1) and (vip-ip1:8080, p1) or cookies. So, if a client connects to vip1:80 and later connects to vip1:8080, the second connection may be sent to a different server than the first. When persistence_shared is enabled, then the second connection will always connect to the same server as the original connection. For COOKIE persistence type, the same cookie will be shared by multiple virtual servers. For SOURCE_IP persistence type, the persistence table will be shared across virtual servers. For GENERIC persistence type, the persistence table will be shared across virtual servers which consume the same persistence profile in LBRule actions.	boolean	Default: "False"
purge	Persistence purge setting Persistence purge setting.	SourceIpPersistencePurge	Default: "FULL"
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value LBSourceIpPersistenceProfile	string	Required Enum: LBSourceIpPersistenceProfile, LBCookiePersistenceProfile, LBGenericPersistenceProfile
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
timeout	Persistence entry expiration time in seconds When all connections complete (reference count reaches 0), persistence entry timer is started with the expiration time.	integer	Minimum: 1 Maximum: 2147483647 Default: "300"
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

LBSslModeSelectionAction (schema)

Action to select SSL mode

This action is used to select SSL mode. Three types of SSL mode actions can
be specified in Transport phase, ssl passthrough, ssl offloading and ssl
end-to-end.

Name	Description	Type	Notes
ssl_mode	Type of SSL mode SSL Passthrough: LB establishes a TCP connection with client and another connection with selected backend server. LB won't inspect the stream data between client and backend server, but just pass it through. Backend server exchanges SSL connection with client. SSL Offloading: LB terminiates the connections from client, and establishes SSL connection with it. After receiving the HTTP request, LB connects the selected backend server and talk with it via HTTP without SSL. LB estalishes new connection to selected backend server for each HTTP request, in case server_keep_alive or multiplexing are NOT configured. SSL End-to-End: LB terminiates the connections from client, and establishes SSL connection with it. After receiving the HTTP request, LB connects the selected backend server and talk with it via HTTPS. LB estalishes new SSL connection to selected backend server for each HTTP request, in case server_keep_alive or multiplexing are NOT configured.	string	Required Enum: SSL_PASSTHROUGH, SSL_END_TO_END, SSL_OFFLOAD
type	Must be set to the value LBSslModeSelectionAction	LBRuleActionType	Required

LBSslProfile (schema)

Load balancer abstract SSL profile

Load balancer abstract SSL profile.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 LBSslProfile	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

LBSslSniCondition (schema)

Condition to match SSL SNI in client hello

This condition is used to match SSL SNI in client hello. This condition is
only supported in TRANSPORT phase and HTTP_FORWARDING.

Name	Description	Type	Notes
case_sensitive	A case sensitive flag for SNI comparing If true, case is significant when comparing SNI value.	boolean	Default: "True"
inverse	A flag to indicate whether reverse the match result of this condition	boolean	Default: "False"
match_type	Match type of SNI	LbRuleMatchType	Default: "REGEX"
sni	The server name indication The SNI(Server Name indication) in client hello message.	string	Required
type	Must be set to the value LBSslSniCondition	LBRuleConditionType	Required

LBTcpHeaderCondition (schema)

Condition to match TCP header fields

This condition is used to match TCP header fields of HTTP messages.
Currently, only the TCP source port is supported. Ports can be expressed as
a single port number like 80, or a port range like 1024-1030.

Name	Description	Type	Notes
inverse	A flag to indicate whether reverse the match result of this condition	boolean	Default: "False"
source_port	TCP source port of HTTP message	PortElement	Required
type	Must be set to the value LBTcpHeaderCondition	LBRuleConditionType	Required

LBTcpMonitorProfile (schema)

LBMonitorProfile for active health checks over TCP

Active healthchecks are disabled by default and can be enabled for a
server pool by binding a health monitor to the Group through the
LBRule object. This represents active health monitoring over TCP.
Active healthchecks are initiated periodically, at a configurable
interval, to each member of the Group. Only if a healthcheck fails
consecutively for a specified number of times (fall_count) to a member
will the member status be marked DOWN. Once a member is DOWN, a specified
number of consecutive successful healthchecks (rise_count) will bring
the member back to UP state. After a healthcheck is initiated, if it
does not complete within a certain period, then also
the healthcheck is considered to be unsuccessful. Completing a
healthcheck within timeout means establishing a connection (TCP or SSL),
if applicable, sending the request and receiving the response, all within
the configured timeout.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
fall_count	Monitor fall count for active healthchecks Only if a healthcheck fails consecutively for a specified number of times, given with fall_count, to a member will the member status be marked DOWN.	integer	Minimum: 1 Maximum: 2147483647 Default: "3"
id	Unique identifier of this resource	string	Sortable
interval	Monitor interval in seconds for active healthchecks Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group.	integer	Minimum: 1 Maximum: 2147483647 Default: "5"
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
monitor_port	Monitor port for active healthchecks Typically, monitors perform healthchecks to Group members using the member IP address and pool_port. However, in some cases, customers prefer to run healthchecks against a different port than the pool member port which handles actual application traffic. In such cases, the port to run healthchecks against can be specified in the monitor_port value. For ICMP monitor, monitor_port is not required.	int	Minimum: 0 Maximum: 65535
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
receive	Expected data received from server Expected data, if specified, can be anywhere in the response and it has to be a string, regular expressions are not supported.	string
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value LBTcpMonitorProfile	LBMonitorProfileType	Required
rise_count	Monitor rise count for active healthchecks Once a member is DOWN, a specified number of consecutive successful healthchecks specified by rise_count will bring the member back to UP state.	integer	Minimum: 1 Maximum: 2147483647 Default: "3"
send	Data to send If both send and receive are not specified, then just a TCP connection is established (3-way handshake) to validate server is healthy, no data is sent.	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
timeout	Monitor timeout in seconds for active healthchecks Timeout specified in seconds. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.	integer	Minimum: 1 Maximum: 2147483647 Default: "5"
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

LBUdpMonitorProfile (schema)

LBMonitorProfile for active health checks over UDP

Active healthchecks are disabled by default and can be enabled for a
server pool by binding a health monitor to the Group through the LBRule
object. This represents active health monitoring over UDP. Active
healthchecks are initiated periodically, at a configurable interval, to
each member of the Group. Only if a healthcheck fails consecutively for a
specified number of times (fall_count) to a member will the member status
be marked DOWN. Once a member is DOWN, a specified number of consecutive
successful healthchecks (rise_count) will bring the member back to UP
state. After a healthcheck is initiated, if it does not complete within a
certain period, then also the healthcheck is considered to be
unsuccessful. Completing a healthcheck within timeout means establishing
a connection (TCP or SSL), if applicable, sending the request and
receiving the response, all within the configured timeout.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
fall_count	Monitor fall count for active healthchecks Only if a healthcheck fails consecutively for a specified number of times, given with fall_count, to a member will the member status be marked DOWN.	integer	Minimum: 1 Maximum: 2147483647 Default: "3"
id	Unique identifier of this resource	string	Sortable
interval	Monitor interval in seconds for active healthchecks Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group.	integer	Minimum: 1 Maximum: 2147483647 Default: "5"
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
monitor_port	Monitor port for active healthchecks Typically, monitors perform healthchecks to Group members using the member IP address and pool_port. However, in some cases, customers prefer to run healthchecks against a different port than the pool member port which handles actual application traffic. In such cases, the port to run healthchecks against can be specified in the monitor_port value. For ICMP monitor, monitor_port is not required.	int	Minimum: 0 Maximum: 65535
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
receive	Expected data received from server Expected data, can be anywhere in the response and it has to be a string, regular expressions are not supported. UDP healthcheck is considered failed if there is no server response within the timeout period.	string	Required
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value LBUdpMonitorProfile	LBMonitorProfileType	Required
rise_count	Monitor rise count for active healthchecks Once a member is DOWN, a specified number of consecutive successful healthchecks specified by rise_count will bring the member back to UP state.	integer	Minimum: 1 Maximum: 2147483647 Default: "3"
send	Data to send The data to be sent to the monitored server.	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
timeout	Monitor timeout in seconds for active healthchecks Timeout specified in seconds. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.	integer	Minimum: 1 Maximum: 2147483647 Default: "5"
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

LBVariableAssignmentAction (schema)

Action to create variable and assign value to it

This action is used to create a new variable and assign value to it.
One action can be used to create one variable. To create multiple
variables, multiple actions must be defined.
The variables can be used by LBVariableCondition, etc.

Name	Description	Type	Notes
type	Must be set to the value LBVariableAssignmentAction	LBRuleActionType	Required
variable_name	Name of the variable to be assigned Name of the variable to be assigned.	string	Required
variable_value	Value of variable Value of variable.	string	Required

LBVariableCondition (schema)

Condition to match IP header fields

This condition is used to match variable's name and value at all
phases. The variables could be captured from REGEX or assigned by
LBVariableAssignmentAction or system embedded variable. Varialbe_name
and variable_value should be matched at the same time.

Name	Description	Type	Notes
case_sensitive	A case sensitive flag for variable value comparing If true, case is significant when comparing variable value.	boolean	Default: "True"
inverse	A flag to indicate whether reverse the match result of this condition	boolean	Default: "False"
match_type	Match type of variable value	LbRuleMatchType	Default: "REGEX"
type	Must be set to the value LBVariableCondition	LBRuleConditionType	Required
variable_name	Name of the variable to be matched	string	Required
variable_value	Value of variable to be matched	string	Required

LBVariablePersistenceLearnAction (schema)

Action to learn the variable value

This action is performed in HTTP response rewrite phase. It is used to
learn the value of variable from the HTTP response, and insert an entry
into the persistence table if the entry doesn't exist.

Name	Description	Type	Notes
persistence_profile_path	Path to LBPersistenceProfile If the persistence profile path is not specified, a default persistence table is created per virtual server. Currently, only LBGenericPersistenceProfile is supported.	string
type	Must be set to the value LBVariablePersistenceLearnAction	LBRuleActionType	Required
variable_hash_enabled	Whether to enable a hash operation for variable value The property is used to enable a hash operation for variable value when composing the persistence key.	boolean	Default: "False"
variable_name	Variable name The property is the name of variable to be learnt. It is used to identify which variable's value is learnt from HTTP response. The variable can be a built-in variable such as "_cookie_JSESSIONID", a customized variable defined in LBVariableAssignmentAction or a captured variable in regular expression such as "article". For the full list of built-in variables, please reference the NSX-T Administrator's Guide.	string	Required

LBVariablePersistenceOnAction (schema)

Action to persist the variable value

This action is performed in HTTP forwarding phase. It is used to inspect
the variable of HTTP request, and look up the persistence entry with its
value and pool uuid as key.
If the persistence entry is found, the HTTP request is forwarded to the
recorded backend server according to the persistence entry.
If the persistence entry is not found, a new entry is created in the
table after backend server is selected.

Name	Description	Type	Notes
persistence_profile_path	Path to LBPersistenceProfile If the persistence profile path is not specified, a default persistence table is created per virtual server. Currently, only LBGenericPersistenceProfile is supported.	string
type	Must be set to the value LBVariablePersistenceOnAction	LBRuleActionType	Required
variable_hash_enabled	Whether to enable a hash operation for variable value The property is used to enable a hash operation for variable value when composing the persistence key.	boolean	Default: "False"
variable_name	Variable name The property is the name of variable to be used. It specifies which variable's value of a HTTP Request will be used in the key of persistence entry. The variable can be a built-in variable such as "_cookie_JSESSIONID", a customized variable defined in LBVariableAssignmentAction or a captured variable in regular expression such as "article". For the full list of built-in variables, please reference the NSX-T Administrator's Guide.	string	Required

LBVirtualServer (schema)

Base class for each type of LBVirtualServer

All the types of LBVirtualServer extend from this abstract class. This
is present for extensibility.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
access_list_control	IP access list control to filter the connections Specifies the access list control to define how to filter the connections from clients.	LBAccessListControl
access_log_enabled	Access log enabled setting If access log is enabled, all HTTP requests sent to L7 virtual server are logged to the access log file. Both successful returns information responses(1xx), successful responses(2xx), redirection messages(3xx) and unsuccessful requests, backend server returns 4xx or 5xx, are logged to access log, if enabled. All L4 virtual server connections are also logged to the access log if enabled. The non-significant events such as successful requests are not logged if log_significant_event_only is set to true.	boolean	Default: "False"
application_profile_path	Application profile path The application profile defines the application protocol characteristics. It is used to influence how load balancing is performed. Currently, LBFastTCPProfile, LBFastUDPProfile and LBHttpProfile, etc are supported.	string	Required
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
client_ssl_profile_binding	Virtual server side SSL binding setting The setting is used when load balancer acts as an SSL server and terminating the client SSL connection	LBClientSslProfileBinding
default_pool_member_ports	Default pool member ports when member port is not defined. Default pool member ports when member port is not defined.	array of PortElement	Maximum items: 14
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
enabled	whether the virtual server is enabled Flag to enable the load balancer virtual server.	boolean	Default: "True"
id	Unique identifier of this resource	string	Sortable
ip_address	IP address of the LBVirtualServer Configures the IP address of the LBVirtualServer where it receives all client connections and distributes them among the backend servers.	IPAddress	Required
lb_persistence_profile_path	Persistence Profile used by LBVirtualServer Path to optional object that enables persistence on a virtual server allowing related client connections to be sent to the same backend server. Persistence is disabled by default.	string
lb_service_path	Path to LBService object for LBVirtualServer virtual servers can be associated to LBService(which is similar to physical/virtual load balancer), LB virtual servers, pools and other entities could be defined independently, the LBService identifier list here would be used to maintain the relationship of LBService and other LB entities.	string
log_significant_event_only	Log only significant event in access log The property log_significant_event_only can take effect only when access_log_enabled is true. If log_significant_event_only is true, significant events are logged in access log. For L4 virtual server, significant event means unsuccessful(error or dropped) TCP/UDP connections. For L7 virtual server, significant event means unsuccessful connections or HTTP/HTTPS requests which have error response code(e.g. 4xx, 5xx).	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
max_concurrent_connections	Maximum concurrent connection number To ensure one virtual server does not over consume resources, affecting other applications hosted on the same LBS, connections to a virtual server can be capped. If it is not specified, it means that connections are unlimited.	integer	Minimum: 1 Maximum: 2147483647
max_new_connection_rate	Maximum new connection rate in connections per second To ensure one virtual server does not over consume resources, connections to a member can be rate limited. If it is not specified, it means that connection rate is unlimited.	integer	Minimum: 1 Maximum: 2147483647
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
pool_path	Default server pool path The server pool(LBPool) contains backend servers. Server pool consists of one or more servers, also referred to as pool members, that are similarly configured and are running the same application.	string
ports	Virtual server port number(s) or port range(s) Ports contains a list of at least one port or port range such as "80", "1234-1236". Each port element in the list should be a single port or a single port range.	array of PortElement	Required
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value LBVirtualServer	string
rules	List of load balancer rules Load balancer rules allow customization of load balancing behavior using match/action rules. Currently, load balancer rules are supported for only layer 7 virtual servers with LBHttpProfile.	array of LBRule	Maximum items: 4000
server_ssl_profile_binding	Pool side SSL binding setting The setting is used when load balancer acts as an SSL client and establishing a connection to the backend server.	LBServerSslProfileBinding
sorry_pool_path	Sorry server pool path When load balancer can not select a backend server to serve the request in default pool or pool in rules, the request would be served by sorry server pool.	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

LBXForwardedForType (schema)

X-forwarded-for type

X-forwarded-for type.

Name	Description	Type	Notes
LBXForwardedForType	X-forwarded-for type X-forwarded-for type.	string	Enum: INSERT, REPLACE

Label (schema)

Label

Label that will be displayed for a UI element.

Name	Description	Type	Notes
condition	Expression for evaluating condition If the condition is met then the label will be applied. Examples of expression syntax are provided under example_request section of CreateWidgetConfiguration API.	string	Maximum length: 1024
hover	Show label only on hover If true, displays the label only on hover	boolean	Default: "False"
icons	Icons Icons to be applied at dashboard for the label	array of Icon	Minimum items: 0
navigation	Navigation to a specified UI page Hyperlink of the specified UI page that provides details.	string	Maximum length: 1024
text	Label text Text to be displayed at the label.	string	Required Maximum length: 255

LabelValueConfiguration (schema)

Label Value Dashboard Widget Configuration

Represents a Label-Value widget configuration

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
datasources	Array of Datasource Instances with their relative urls The 'datasources' represent the sources from which data will be fetched. Currently, only NSX-API is supported as a 'default' datasource. An example of specifying 'default' datasource along with the urls to fetch data from is given at 'example_request' section of 'CreateWidgetConfiguration' API.	array of Datasource	Minimum items: 0
default_filter_value	Default filter value to be passed to datasources Default filter values to be passed to datasources. This will be used when the report is requested without filter values.	array of DefaultFilterValue
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Widget Title Title of the widget. If display_name is omitted, the widget will be shown without a title.	string	Maximum length: 255
drilldown_id	Id of drilldown widget Id of drilldown widget, if any. Id should be a valid id of an existing widget. A widget is considered as drilldown widget when it is associated with any other widget and provides more detailed information about any data item from the parent widget.	string	Maximum length: 255
feature_set	Features required to view the widget Features required to view the widget.	FeatureSet
filter	Id of filter widget for subscription Id of filter widget for subscription, if any. Id should be a valid id of an existing filter widget. Filter widget should be from the same view. Datasource URLs should have placeholder values equal to filter alias to accept the filter value on filter change.	string
filter_value_required	Flag to indicate if filter value is necessary Flag to indicate that widget will continue to work without filter value. If this flag is set to false then default_filter_value is manadatory.	boolean	Default: "True"
footer		Footer
icons	Icons Icons to be applied at dashboard for widgets and UI elements.	array of Icon
id	Unique identifier of this resource	string	Sortable
is_drilldown	Set as a drilldown widget Set to true if this widget should be used as a drilldown.	boolean	Default: "False"
layout	Layout of properties inside widget Layout of properties can be vertical or grid. If layout is not specified a default vertical layout is applied.	Layout
legend	Legend for the widget Legend to be displayed. If legend is not needed, do not include it.	Legend
navigation	Navigation to a specified UI page Hyperlink of the specified UI page that provides details.	string	Maximum length: 1024
properties	Rows An array of label-value properties.	array of PropertyItem	Required
resource_type	Must be set to the value LabelValueConfiguration	string	Required Readonly Enum: LabelValueConfiguration, DonutConfiguration, MultiWidgetConfiguration, ContainerConfiguration, StatsConfiguration, GridConfiguration, GraphConfiguration, CustomWidgetConfiguration, DropdownFilterWidgetConfiguration Maximum length: 255
shared	Visiblity of widgets to other users Please use the property 'shared' of View instead of this. The widgets of a shared view are visible to other users.	boolean	Deprecated
span	Horizontal span Represents the horizontal span of the widget / container.	int	Minimum: 1 Maximum: 12
sub_type	Sub-type of the LabelValueConfiguration A sub-type of LabelValueConfiguration. If sub-type is not specified the parent type is rendered. For VERTICALLY_ALIGNED sub_type, the value is placed below the label.	string	Enum: VERTICALLY_ALIGNED
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
weight	Weightage or placement of the widget or container Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details.	int	Deprecated

LacpGroupConfigInfo (schema)

Name	Description	Type	Notes
key	The generated key as the identifier for the group The key represents the identifier for the group that is unique across VC.	string
load_balance_algorithm	Load balance policy Load balance algorithm used in LACP group. The possible values are dictated by the values available in VC. Please refer VMwareDvsLacpLoadBalanceAlgorithm documentation for a full list of values. A few examples are srcDestIp where source and destination IP are considered, srcIp where only source IP is considered.	string
mode	The mode of Link Aggregation Control Protocol (LACP) The mode of LACP can be ACTIVE or PASSIVE. If the mode is ACTIVE, LACP is enabled unconditionally. If the mode is PASSIVE, LACP is enabled only if LACP device is detected.	string	Enum: ACTIVE, PASSIVE
name	The display name The display name of the LACP group.	string
uplink_names	Uplink names Names for the uplink ports in the group.	array of string
uplink_num	The number of uplink ports	integer
uplink_port_keys	Keys for the uplink ports Keys for the uplink ports in the group. Each uplink port is assigned a key that is unique across VC.	array of string

Layout (schema)

Layout of a container or widget

Represents layout of a container or widget

Name	Description	Type	Notes
properties		LayoutProperties
type	Type of layout of a container or widget Describes layout of a container or widget. Layout describes how individual widgets are placed inside the container. For example, if HORIZONTAL is chosen widgets are placed side by side inside the container. If VERTICAL is chosen then widgets are placed one below the other. If GRID is chosen then the container or widget display area is divided into a grid of m rows and n columns, as specified in the properties, and the widgets are placed inside the grid.	string	Enum: HORIZONTAL, VERTICAL, GRID Default: "HORIZONTAL"

LayoutProperties (schema)

Layout properties of a container or widget

Properties of the layout of a container or widget

Name	Description	Type	Notes
num_columns	Number of columns of grid Describes the number of columns of grid layout of a container or widget. This property is applicable for grid layout only.	int
num_rows	Number of rows of grid Describes the number of rows of grid layout of a container or widget. This property is applicable for grid layout only.	int

LbHttpRequestHeader (schema)

Name	Description	Type	Notes
header_name	Name of HTTP request header	string	Required
header_value	Value of HTTP request header	string	Required

LbLogLevel (schema)

the log level of load balancer service

Name	Description	Type	Notes
LbLogLevel	the log level of load balancer service	string	Enum: DEBUG, INFO, WARNING, ERROR, CRITICAL, ALERT, EMERGENCY

LbRuleMatchType (schema)

Match type for LbRule conditions

LbRuleMatchType is used to determine how a specified string value is used
to match a specified LbRuleCondition field.
STARTS_WITH: If the LbRuleCondition field starts with specified string, the
condition matches. The fields with this match type are specified as
strings, not regular expressions.
ENDS_WITH: If the LbRuleCondition field ends with specified string, the
condition matches. The fields with this match type are specified as
strings, not regular expressions.
EQUALS: If the LbRuleCondition field is same as the specified string, the
condition matches. The fields with this match type are specified as
strings, not regular expressions.
CONTAINS: If the LbRuleCondition field contains the specified string, the
condition matches. The fields with this match type are specified as
strings, not regular expressions.
REGEX: If the LbRuleCondition field matches specified regular expression,
the condition matches. The regular expressions in load balancer rules use
the features common to both Java regular expressions and Perl Compatible
Regular Expressions (PCREs) with some restrictions. Reference
http://www.pcre.org for PCRE and the NSX-T Administrator's Guide for the
restrictions.
If named capturing groups are used in the regular expression, when a
match succeeds, the substrings of the subject string that match named
capturing groups are stored (captured) in variables with specific names
which can be used in the fields of LbRuleAction which support variables.
Named capturing group are defined in the format (?<name>subpattern),
such as (?<year>\d{4}).
For example, in the regular expression:
"/news/(?<year>\d+)/(?<month>\d+)/(?<article>.*)", for
subject string "/news/2017/06/xyz.html", the substring "2017" is captured
in variable year, "06" is captured in variable month, and "xyz.html" is
captured in variable article. These variables can be used in LbRuleAction
fields which support variables in form of $name, such as $year, $month,
$article.
Please note, when regular expressions are used in JSON(JavaScript Object
Notation) string, every backslash character (\) needs to be escaped by one
additional backslash character.

Name	Description	Type	Notes
LbRuleMatchType	Match type for LbRule conditions LbRuleMatchType is used to determine how a specified string value is used to match a specified LbRuleCondition field. STARTS_WITH: If the LbRuleCondition field starts with specified string, the condition matches. The fields with this match type are specified as strings, not regular expressions. ENDS_WITH: If the LbRuleCondition field ends with specified string, the condition matches. The fields with this match type are specified as strings, not regular expressions. EQUALS: If the LbRuleCondition field is same as the specified string, the condition matches. The fields with this match type are specified as strings, not regular expressions. CONTAINS: If the LbRuleCondition field contains the specified string, the condition matches. The fields with this match type are specified as strings, not regular expressions. REGEX: If the LbRuleCondition field matches specified regular expression, the condition matches. The regular expressions in load balancer rules use the features common to both Java regular expressions and Perl Compatible Regular Expressions (PCREs) with some restrictions. Reference http://www.pcre.org for PCRE and the NSX-T Administrator's Guide for the restrictions. If named capturing groups are used in the regular expression, when a match succeeds, the substrings of the subject string that match named capturing groups are stored (captured) in variables with specific names which can be used in the fields of LbRuleAction which support variables. Named capturing group are defined in the format (?<name>subpattern), such as (?<year>\d{4}). For example, in the regular expression: "/news/(?<year>\d+)/(?<month>\d+)/(?<article>.*)", for subject string "/news/2017/06/xyz.html", the substring "2017" is captured in variable year, "06" is captured in variable month, and "xyz.html" is captured in variable article. These variables can be used in LbRuleAction fields which support variables in form of $name, such as $year, $month, $article. Please note, when regular expressions are used in JSON(JavaScript Object Notation) string, every backslash character (\) needs to be escaped by one additional backslash character.	string	Enum: STARTS_WITH, ENDS_WITH, EQUALS, CONTAINS, REGEX

LbServiceSize (schema)

the size of load balancer service

The size of load balancer service can be, SMALL, MEDIUM, LARGE, XLARGE, or
DLB. The first four sizes are realized on Edge node as a centralized load
balancer. DLB is realized on each ESXi hypervisor as a distributed load
balancer. DLB is supported for k8s cluster IPs managed by vSphere with
Kubernetes. DLB is NOT supported for any other workload types.

Name	Description	Type	Notes
LbServiceSize	the size of load balancer service The size of load balancer service can be, SMALL, MEDIUM, LARGE, XLARGE, or DLB. The first four sizes are realized on Edge node as a centralized load balancer. DLB is realized on each ESXi hypervisor as a distributed load balancer. DLB is supported for k8s cluster IPs managed by vSphere with Kubernetes. DLB is NOT supported for any other workload types.	string	Enum: SMALL, MEDIUM, LARGE, XLARGE, DLB

LbSslSessionReusedType (schema)

Type of SSL session reused

Name	Description	Type	Notes
LbSslSessionReusedType	Type of SSL session reused	string	Enum: IGNORE, REUSED, NEW

LdapIdentitySource (schema)

An LDAP identity source

This is the base type for all identity sources that use LDAP for authentication and group membership. This is an abstract type. Concrete child types:
ActiveDirectoryIdentitySource
OpenLdapIdentitySource

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
alternative_domain_names	Additional domains to be directed to this identity source After parsing the "user@domain", the domain portion is used to select the LDAP identity source to use. Additional domains listed here will also be directed to this LDAP identity source. In Active Directory these are sometimes referred to as Alternative UPN Suffixes.	array of string
base_dn	DN of subtree for user and group searches The subtree of the LDAP identity source to search when locating users and groups.	string	Required
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
domain_name	Authentication domain name The name of the authentication domain. When users log into NSX using an identity of the form "user@domain", NSX uses the domain portion to determine which LDAP identity source to use.	string	Required
id	Unique identifier of this resource	string	Sortable
ldap_servers	LDAP servers for this identity source The list of LDAP servers that provide LDAP service for this identity source. Currently, only one LDAP server is supported.	array of IdentitySourceLdapServer	Maximum items: 1
resource_type	Must be set to the value LdapIdentitySource	string	Required Enum: ActiveDirectoryIdentitySource, OpenLdapIdentitySource
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

LdapIdentitySourceListResult (schema)

List results containing LDAP identity sources

The results of listing LDAP identity sources.

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results		array of LdapIdentitySource (Abstract type: pass one of the following concrete types) ActiveDirectoryIdentitySource OpenLdapIdentitySource
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

LdapIdentitySourceProbeResults (schema)

Results from probing all LDAP servers

Results from probing all LDAP servers in an LDAP identity source configuration.

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
results	Probe results Probe results for all probed LDAP servers.	array of IdentitySourceLdapServerProbeResult

LdapIdentitySourceSearchRequestParameters (schema)

Arguments for searching users and groups

To search for a user or group in an LDAP identity source,
provide a filter_value. The directory will be searched for
users and groups that match the search string.

User searches:

For Active Directory sources, the directory will be searched
for users whose commonName (CN) property contains the given
string and for users whose samAccountName property contains
the given string. For OpenLDAP sources, the directory will
be searched for users whose commonName (CN) property contains
the given string and for users whose uid property contains
the given string.

Group searches:

For both Active Directory and OpenLDAP sources, the directory
will be searched for groups whose commonName (CN) property
contains the the given string.

The LDAP server may impose a limit on the number of returned
entries.

Name	Description	Type	Notes
filter_value	Search filter value A string to use when searching for groups in the LDAP identity source. If not provided, all groups are returned.	string

LdapIdentitySourceSearchResultItem (schema)

Name	Description	Type	Notes
common_name	Common Name (CN) of entry The Common Name (CN) of the entry, if available.	string
dn	DN of the entry Distinguished name (DN) of the entry.	string
principal_name	The principal name of the user or group, if available For Active Directory (AD) users, this will be the user principal name (UPN), in the format user@domain. For non-AD users, this will be the user's uid property, followed by "@" and the domain of the directory. For groups, this will be the group's common name, followed by "@" and the domain of the directory.	string
type	Type of the entry Describes the type of the entry	string	Enum: USER, GROUP

LdapIdentitySourceSearchResultList (schema)

A list of LDAP search results

A list of LDA entries returned from a search of an LDAP identity source.

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
results		array of LdapIdentitySourceSearchResultItem

LdapProbeError (schema)

Error detail from probe

Detail about one error encountered during a probe.

Name	Description	Type	Notes
error_type	Error type The cause of the error. BASE_DN_NOT_FOUND: The configured base DN does not exist on the LDAP server or is not readable. BIND_DN_AND_PASSWORD_REQUIRED: This server is configured to require a bind DN and password. Please add these to your LDAP server configuration. BIND_DN_INVALID: The bind DN or username provided is not valid on the LDAP server. Check that the bind DN is correct. This error may also indicate that the base DN in your configuration is incorrect. CERTIFICATE_HOSTNAME_MISMATCH_ERROR: The hostname configured for the LDAP server does not match the hostname in the server's certificate subject or alternative subject names. Be sure that the hostname you configure in NSX Manager matches one of those names. CERTIFICATE_MISMATCH_ERROR: The certificate presented by the LDAP server did not match the certificate in the configuration on the NSX Manager. CONNECTION_REFUSED: The connection was refused when contacting the LDAP server. Ensure that the LDAP server is running and that you are using the correct ip/hostname. CONNECTION_TIMEOUT: The connection timed out when contacting the LDAP server. Check the hostname/ip and any firewalls between the NSX Manager and the LDAP server. GENERAL_ERROR: An undetermined error occurred. INVALID_CONFIGURED_CERTIFICATE: The certificate configured for this LDAP server is invalid and could not be decoded. Check that the PEM-formatted certificate you provided is correct. INVALID_CREDENTIALS: The username and/or password are incorrect. SSL_HANDSHAKE_ERROR: An error occurred while establishing a secure connection with the LDAP server. Check that the LDAP server's certificate is correct, and that it is using an SSL/TLS cipher suite that is compatible with the NSX Manager. This error can also occur if the hostname you have configured for the LDAP server does not match any of the hostnames in the Subject Alternative Name records in the server certificate. STARTTLS_FAILED: Unable to use StartTLS to upgrade the connection to use TLS. Ensure that the LDAP server supports TLS and if not, use LDAP or LDAPS as the protocol. UNKNOWN_HOST: The hostname of the LDAP server could not be resolved.	string	Enum: BASE_DN_NOT_FOUND, BIND_DN_AND_PASSWORD_REQUIRED, BIND_DN_INVALID, CERTIFICATE_HOSTNAME_MISMATCH_ERROR, CERTIFICATE_MISMATCH_ERROR, CONNECTION_REFUSED, CONNECTION_TIMEOUT, GENERAL_ERROR, INVALID_CONFIGURED_CERTIFICATE, INVALID_CREDENTIALS, SSL_HANDSHAKE_ERROR, STARTTLS_FAILED, UNKNOWN_HOST

Legend (schema)

Legend for the widget

Represents legend that describes the entities of the widget.

Name	Description	Type	Notes
alignment	Alignment of the legend Describes the alignment of legend. Alignment of a legend denotes how individual items of the legend are aligned in a container. For example, if VERTICAL is chosen then the items of the legend will appear one below the other and if HORIZONTAL is chosen then the items will appear side by side.	string	Enum: HORIZONTAL, VERTICAL Default: "VERTICAL"
display_count	Show count of entities in the legend If set to true, it will display the counts in legend. If set to false, counts of entities are not displayed in the legend.	boolean	Default: "True"
position	Placement of legend Describes the relative placement of legend. The legend of a widget can be placed either to the TOP or BOTTOM or LEFT or RIGHT relative to the widget. For example, if RIGHT is chosen then legend is placed to the right of the widget.	string	Enum: TOP, BOTTOM, LEFT, RIGHT, TOP_RIGHT Default: "RIGHT"
type	Type of the legend Describes the render type for the legend. The legend for an entity describes the entity in the widget. The supported legend type is a circle against which the entity's details such as display_name are shown. The color of the circle denotes the color of the entity shown inside the widget.	string	Enum: CIRCLE Default: "CIRCLE"
unit	Show unit of entities in the legend Show unit of entities in the legend.	string

ListByNodeIdParameters (schema)

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string
source	The data source, either realtime or cached. If not provided, cached data is returned.	DataSourceType
transport_node_id	TransportNode Id	string

ListByOptionalTransportNodeParameters (schema)

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
edge_path	Transport node	string
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

ListCertParameter (schema)

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
details	whether to expand the pem data and show all its details	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string
type	Type of certificate to return Provide this parameter to limit the list of returned certificates to those matching a particular usage. Passing cluster_certificate will return the certificate used for the cluster wide API service.	string	Enum: cluster_api_certificate

ListRequestParameters (schema)

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

ListResult (schema)

Base class for list results from collections

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

ListResultQueryParameters (schema)

Parameters that affect how list results are processed

Name	Description	Type	Notes
fields	Fields to include in query results Comma-separated field names to include in query result	string

ListWithDataSourceParameters (schema)

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string
source	The data source, either realtime or cached. If not provided, cached data is returned.	DataSourceType

LiveTraceConfig (schema)

Livetrace configuration

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
actions	Livetrace actions Configuration of actions on the filtered packets.	PolicyLiveTraceActionConfig	Required
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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
filter	Packet filter Filter for flows of interest.	LiveTraceFilterData (Abstract type: pass one of the following concrete types) FieldsFilterData PlainFilterData
id	Unique identifier of this resource	string	Sortable
is_transient	Marker to indicate if the intent is transient This field indicates whether the intent is transient. If it is set to true, intent will be cleaned up after 1 hour of inactivity.	boolean	Default: "True"
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 LiveTraceConfig	string
src_port_path	Policy path of logical port Policy path of logical port to start a livetrace session.	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
timeout	Timeout in seconds for livetrace session The duration for observing live traffic on the specified source logical port.	integer	Minimum: 5 Maximum: 300 Default: "10"
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

LiveTraceFilterData (schema)

This is an abstract type. Concrete child types:
FieldsFilterData
PlainFilterData

Name	Description	Type	Notes
resource_type	Filter type	string	Required Enum: FieldsFilterData, PlainFilterData Default: "FieldsFilterData"

LiveTracePacketGranularActionConfig (schema)

Configuration of livetrace packet granular action

Name	Description	Type	Notes
dest_port_path	Policy path of logical port Policy path of logical port for the reverse direction of a livetrace session. It is required only when the trace type is bidirectional. Multiple bi-directional actions in a livetrace session should have the same port specified for the reverse direction.	string
reverse_filter	Packet filter Filter for flows of interest at the reverse direction. It is required only when the trace type is bidirectional. Multiple bi-directional actions in a livetrace session should have the same filter specified for the reverse direction.	LiveTraceFilterData (Abstract type: pass one of the following concrete types) FieldsFilterData PlainFilterData
sampling	Sampling parameter for the action Sampling parameter for the action. Trace action and packet capture action only support first-N sampling.	LiveTraceSamplingConfig	Required
trace_type	Type of trace	string	Required Enum: UNI_DIRECTIONAL, BI_DIRECTIONAL

LiveTraceSamplingConfig (schema)

Sampling parameter for a livetrace action

Name	Description	Type	Notes
match_number	Parameter for first-N sampling. First N packets are sampled.	integer	Minimum: 1 Maximum: 50
sampling_interval	Parameter for interval based sampling A packet is sampled for every given time interval in ms.	integer	Minimum: 1 Maximum: 30000
sampling_rate	Parameter for packet number based sampling 1 out of N packets is sampled on average.	integer	Minimum: 1 Maximum: 65535

LocalEgress (schema)

Local Egress

Local Egress is used on both server and client sites so that the gateway
is used for N-S traffic and overhead on L2VPN tunnel is reduced.

Name	Description	Type	Notes
optimized_ips	Gateway IP for Local Egress Gateway IP for Local Egress. Local egress is enabled only when this list is not empty.	array of IPAddress	Minimum items: 1 Maximum items: 1

LocalEgressRoutingEntry (schema)

Local egress routing policy

Name	Description	Type	Notes
nexthop_address	Next hop address Next hop address for proximity routing.	string	Required
prefix_list_paths	Policy path to prefix lists The destination address of traffic matching a prefix-list is forwarded to the nexthop_address. Traffic matching a prefix list with Action DENY will be dropped. Individual prefix-lists specified could have different actions.	array of string	Required Maximum items: 1

LocaleServices (schema)

Locale-services configuration

Site specific configuration of Tier0 in multi-site scenario

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
bfd_profile_path	Policy path of BFD profile This profile is applied to all static route peers in this locale. BFD profile configured on static route peers takes precedence over global configuration. If this field is empty, a default profile is applied to all peers.	string
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource (Abstract type: pass one of the following concrete types) ChildTier1Interface
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
edge_cluster_path	Edge cluster path Policy path to edge cluster. Auto-assigned on Tier0 if associated enforcement-point has only one edge cluster.	string
ha_vip_configs	Array of HA VIP Config. This configuration can be defined only for Active-Standby Tier0 gateway to provide redundancy. For mulitple external interfaces, multiple HA VIP configs must be defined and each config will pair exactly two external interfaces. The VIP will move and will always be owned by the Active node. When this property is configured, configuration of dynamic-routing is not allowed.	array of Tier0HaVipConfig
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
preferred_edge_paths	Edge node path Policy paths to edge nodes. For Tier1 gateway, the field is used to statically assign the ordered list of up to two edge nodes for stateful services. To enable auto allocation of nodes from the specified edge cluster the field must be left unset. The auto allocation of nodes is supported only for the Tier1 gateway. For Tier0 gateway specified edge is used as a preferred edge node when failover mode is set to PREEMPTIVE, not applicable otherwise.	array of string	Maximum items: 2
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value LocaleServices	string
route_redistribution_config	Route Redistribution configuration Configure all route redistribution properties like enable/disable redistributon, redistribution rule and so on.	Tier0RouteRedistributionConfig
route_redistribution_types	Enable redistribution of different types of routes on Tier-0 Enable redistribution of different types of routes on Tier-0. This property is only valid for locale-service under Tier-0. This property is deprecated, please use "route_redistribution_config" property to configure redistribution rules.	array of Tier0RouteRedistributionTypes	Deprecated
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

LocaleServicesListResult (schema)

Paged collection of LocaleServices

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	LocaleServices results	array of LocaleServices	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

LoggingServiceProperties (schema)

Service properties

Name	Description	Type	Notes
logging_level	Service logging level	string	Required Enum: OFF, FATAL, ERROR, WARN, INFO, DEBUG, TRACE
modified_package_logging_levels	Modified package logging levels	string
package_logging_level	Package logging levels	array of PackageLoggingLevels

LogicalPortStatistics (schema)

Name	Description	Type	Notes
dropped_by_security_packets		PacketsDroppedBySecurity	Readonly
last_update_timestamp	Timestamp when the data was last updated; unset if data source has never updated the data.	EpochMsTimestamp	Readonly
logical_port_id	The id of the logical port	string	Required Readonly
mac_learning		MacLearningCounters	Readonly
rx_bytes		DataCounter	Readonly
rx_packets		DataCounter	Readonly
tx_bytes		DataCounter	Readonly
tx_packets		DataCounter	Readonly

LogicalRouterPortCounters (schema)

Name	Description	Type	Notes
blocked_packets	The number of blocked packets The total number of packets blocked.	integer
dad_dropped_packets	The number of duplicate address detected packets dropped Number of duplicate address detected packets dropped.	integer
destination_unsupported_dropped_packets	The number of destination unsupported packets dropped Number of packtes dropped as destination is not supported.	integer
dropped_packets	The number of dropped packets The total number of packets dropped.	integer
firewall_dropped_packets	The number of firewall packets dropped Number of firewall packets dropped.	integer
frag_needed_dropped_packets	The number of fragmentation needed packets dropped Number of fragmentation needed packets dropped.	integer
ipsec_dropped_packets	The number of IPSec packets dropped Number of IPSec packets dropped	integer
ipsec_no_sa_dropped_packets	The number of IPSec no security association packets dropped Number of IPSec no security association packets dropped.	integer
ipsec_no_vti_dropped_packets	The number of IPSec no VTI packets dropped Number of IPSec packets dropped as no VTI is present.	integer
ipsec_pol_block_dropped_packets	The number of IPSec policy block packets dropped Number of IPSec policy block packets dropped.	integer
ipsec_pol_err_dropped_packets	The number of IPSec policy error packets dropped Number of IPSec policy error packets dropped.	integer
ipv6_dropped_packets	The number of IPV6 packets dropped Number of IPV6 packets dropped.	integer
kni_dropped_packets	The number of kernal NIC interface packets dropped Number of DPDK kernal NIC interface packets dropped.	integer
l4port_unsupported_dropped_packets	The number of L4 port unsupported packets dropped Number of packets dropped due to unsupported L4 port.	integer
malformed_dropped_packets	The number of malformed packets dropped Number of packtes dropped as they are malformed.	integer
no_arp_dropped_packets	The number of no ARP packets dropped Number of no ARP packets dropped.	integer
no_linked_dropped_packets	The number of no linked packets dropped Number of packets dropped as no linked ports are present.	integer
no_mem_dropped_packets	The number of no memory packets dropped Number of packets dropped due to insufficient memory.	integer
no_receiver_dropped_packets	The number of no receiver packets dropped Number of packets dropped due to absence of receiver.	integer
no_route_dropped_packets	The number of no route packets dropped	integer
non_ip_dropped_packets	The number of non IP packets dropped Number of non IP packets dropped.	integer
proto_unsupported_dropped_packets	The number of protocol unsupported packets dropped Number of packets dropped as protocol is unsupported.	integer
redirect_dropped_packets	The number of redirect packets dropped Number of redirect packets dropped.	integer
rpf_check_dropped_packets	The number of reverse-path forwarding check packets dropped Number of reverse-path forwarding check packets dropped.	integer
service_insert_dropped_packets	The number of service insert packets dropped Number of service insert packets dropped.	integer
total_bytes	The total number of bytes The total number of bytes transferred.	integer
total_packets	The total number of packets The total number of packets transferred.	integer
ttl_exceeded_dropped_packets	The number of time to live exceeded packets dropped Number of time to live exceeded packets dropped.	integer

LogicalRouterPortStatistics (schema)

Name	Description	Type	Notes
logical_router_port_id	The ID of the logical router port	string	Required
per_node_statistics	Per Node Statistics	array of LogicalRouterPortStatisticsPerNode	Readonly

LogicalRouterPortStatisticsPerNode (schema)

Name	Description	Type	Notes
last_update_timestamp	Timestamp when the data was last updated; unset if data source has never updated the data.	EpochMsTimestamp	Readonly
rx		LogicalRouterPortCounters	Readonly
transport_node_id	The ID of the TransportNode	string	Required Readonly
tx		LogicalRouterPortCounters	Readonly

LogicalRouterPortStatisticsSummary (schema)

Name	Description	Type	Notes
last_update_timestamp	Timestamp when the data was last updated; unset if data source has never updated the data.	EpochMsTimestamp	Readonly
logical_router_port_id	The ID of the logical router port	string	Required
rx		LogicalRouterPortCounters	Readonly
tx		LogicalRouterPortCounters	Readonly

LogicalRouterState (schema)

Realization State of Logical Router.

This holds the state of Logical Router. If there are errors in realizing LR outside of MP, it gives details of the components and specific errors.

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
pending_change_list	List of pending changes Request identifier of the API which modified the entity.	array of string	Readonly
state	Overall state of desired configuration Gives details of state of desired configuration. Additional enums with more details on progress/success/error states are sent for edge node. The success states are NODE_READY and TRANSPORT_NODE_READY, pending states are {VM_DEPLOYMENT_QUEUED, VM_DEPLOYMENT_IN_PROGRESS, REGISTRATION_PENDING} and other values indicate failures. "in_sync" state indicates that the desired configuration has been received by the host to which it applies, but is not yet in effect. When the configuration is actually in effect, the state will change to "success". Please note, failed state is deprecated.	string	Required Readonly Enum: pending, in_progress, success, failed, partial_success, orphaned, unknown, error, in_sync, NOT_AVAILABLE, VM_DEPLOYMENT_QUEUED, VM_DEPLOYMENT_IN_PROGRESS, VM_DEPLOYMENT_FAILED, VM_POWER_ON_IN_PROGRESS, VM_POWER_ON_FAILED, REGISTRATION_PENDING, NODE_NOT_READY, NODE_READY, VM_POWER_OFF_IN_PROGRESS, VM_POWER_OFF_FAILED, VM_UNDEPLOY_IN_PROGRESS, VM_UNDEPLOY_FAILED, VM_UNDEPLOY_SUCCESSFUL, EDGE_CONFIG_ERROR, VM_DEPLOYMENT_RESTARTED, REGISTRATION_FAILED, TRANSPORT_NODE_SYNC_PENDING, TRANSPORT_NODE_CONFIGURATION_MISSING, EDGE_HARDWARE_NOT_SUPPORTED, MULTIPLE_OVERLAY_TZS_NOT_SUPPORTED, TN_OVERLAY_TZ_IN_USE_BY_EDGE_CLUSTER, TZ_ENDPOINTS_NOT_SPECIFIED, NO_PNIC_PREPARED_IN_EDGE, APPLIANCE_INTERNAL_ERROR, VTEP_DHCP_NOT_SUPPORTED, UNSUPPORTED_HOST_SWITCH_PROFILE, UPLINK_HOST_SWITCH_PROFILE_NOT_SPECIFIED, HOSTSWITCH_PROFILE_NOT_FOUND, LLDP_SEND_ENABLED_NOT_SUPPORTED, UNSUPPORTED_NAMED_TEAMING_POLICY, LBSRCID_NOT_SUPPORTED_FOR_EDGE_VM, LACP_NOT_SUPPORTED_FOR_EDGE_VM, STANDBY_UPLINKS_NOT_SUPPORTED_FOR_EDGE_VM, MULTIPLE_ACTIVE_UPLINKS_NOT_SUPPORTED_FOR_EDGE, UNSUPPORTED_LACP_LB_ALGO_FOR_NODE, EDGE_NODE_VERSION_NOT_SUPPORTED, NO_PNIC_SPECIFIED_IN_TN, INVALID_PNIC_DEVICE_NAME, TRANSPORT_NODE_READY, VM_NETWORK_EDIT_PENDING, UNSUPPORTED_DEFAULT_TEAMING_POLICY, MPA_DISCONNECTED, VM_RENAME_PENDING, VM_CONFIG_EDIT_PENDING, VM_NETWORK_EDIT_FAILED, VM_RENAME_FAILED, VM_CONFIG_EDIT_FAILED, VM_CONFIG_DISCREPANCY, VM_NODE_REFRESH_FAILED, VM_PLACEMENT_REFRESH_FAILED, REGISTRATION_TIMEDOUT, REPLACE_FAILED, UPLINK_FROM_TEAMING_POLICY_NOT_MAPPED, LOGICAL_SWITCH_NAMED_TEAMING_HAS_NO_PNIC_BACKING, DELETE_VM_IN_REDEPLOY_FAILED, DEPLOY_VM_IN_REDEPLOY_FAILED, INSUFFICIENT_RESOURCES_IN_EDGE_NODE_FOR_SERVICE

LogicalRouterStatus (schema)

Name	Description	Type	Notes
last_update_timestamp	Timestamp when the data was last updated; unset if data source has never updated the data.	EpochMsTimestamp	Readonly
locale_operation_mode	Location mode for logical router Egress mode for the logical router at given mode	string	Readonly Enum: PRIMARY_LOCATION, SECONDARY_LOCATION
logical_router_id	The id of the logical router	string	Required
per_node_status	Per Node Status	array of LogicalRouterStatusPerNode	Readonly

LogicalRouterStatusPerNode (schema)

Name	Description	Type	Notes
high_availability_status	A service router's HA status on an edge node	string	Required Enum: ACTIVE, STANDBY, DOWN, SYNC, UNKNOWN, ADMIN_DOWN
service_router_id	id of the service router where the router status is retrieved.	string
transport_node_id	id of the transport node where the router status is retrieved.	string	Required

LogicalSwitchStatistics (schema)

Name	Description	Type	Notes
dropped_by_security_packets		PacketsDroppedBySecurity	Readonly
last_update_timestamp	Timestamp when the data was last updated; unset if data source has never updated the data.	EpochMsTimestamp	Readonly
logical_switch_id	The id of the logical Switch	string	Required Readonly
mac_learning		MacLearningCounters	Readonly
rx_bytes		DataCounter	Readonly
rx_packets		DataCounter	Readonly
tx_bytes		DataCounter	Readonly
tx_packets		DataCounter	Readonly

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

MACAddressExpression (schema)

MAC address expression node

Represents MAC address expressions in the form of an array, to support addition of MAC addresses in a group. Avoid creating groups with multiple MACAddressExpression. In future releases, group will be restricted to contain a single MACAddressExpression. To group MAC addresses, use nested groups instead of multiple MACAddressExpression.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
mac_addresses	Array of MAC addresses This array can consist of one or more MAC addresses.	array of MACAddress	Required Minimum items: 1 Maximum items: 4000
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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, ExternalIDExpression, PathExpression, IdentityGroupExpression
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

MACAddressList (schema)

MAC Address members.

List of MAC Addresses.

Name	Description	Type	Notes
mac_addresses	Array of MAC addresses The array contains MAC addresses.	array of MACAddress	Required Minimum items: 1 Maximum items: 4000

MacAddressCsvListResult (schema)

Name	Description	Type	Notes
file_name	File name File name set by HTTP server if API returns CSV result as a file.	string
last_update_timestamp	Timestamp when the data was last updated; unset if data source has never updated the data.	EpochMsTimestamp	Readonly
results		array of MacTableCsvRecord

MacAddressType (schema)

The type of the MAC address

Name	Description	Type	Notes
MacAddressType	The type of the MAC address	string	Enum: STATIC, LEARNED

MacDiscoveryProfile (schema)

Mac Discovery Profile

Mac Discovery Profile

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
mac_change_enabled	Is rule enabled or not Allowing source MAC address change	boolean	Default: "False"
mac_learning_aging_time	Aging time in seconds for learned MAC address Indicates how long learned MAC address remain.	int	Readonly Default: "600"
mac_learning_enabled	Is MAC learning enabled or not Allowing source MAC address learning	boolean	Required
mac_limit	Maximum number of arp bindings The maximum number of MAC addresses that can be learned on this port	int	Minimum: 0 Maximum: 4096 Default: "4096"
mac_limit_policy	Mac Limit Policy The policy after MAC Limit is exceeded	string	Enum: ALLOW, DROP Default: "ALLOW"
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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
remote_overlay_mac_limit	The maximum number of MAC addresses learned on an overlay Logical Switch This property specifies the limit on the maximum number of MACs learned for a remote virtual machine's MAC to VTEP binding per overlay logical switch.	int	Minimum: 2048 Maximum: 8192 Default: "2048"
resource_type	Must be set to the value MacDiscoveryProfile	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly
unknown_unicast_flooding_enabled	Is unknown unicast flooding rule enabled or not Allowing flooding for unlearned MAC for ingress traffic	boolean	Default: "True"

MacDiscoveryProfileListRequestParameters (schema)

Mac Discovery Profile request parameters

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

MacDiscoveryProfileListResult (schema)

Paged collection of Mac Discovery Profiles

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Mac Discovery profile list results	array of MacDiscoveryProfile	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

MacLearningCounters (schema)

Name	Description	Type	Notes
mac_not_learned_packets_allowed	Number of dispatched packets with unknown source MAC address. The number of packets with unknown source MAC address that are dispatched without learning the source MAC address. Applicable only when the MAC limit is reached and MAC Limit policy is MAC_LEARNING_LIMIT_POLICY_ALLOW.	integer
mac_not_learned_packets_dropped	Number of dropped packets with unknown source MAC address. The number of packets with unknown source MAC address that are dropped without learning the source MAC address. Applicable only when the MAC limit is reached and MAC Limit policy is MAC_LEARNING_LIMIT_POLICY_DROP.	integer
macs_learned	Number of MACs learned	integer

MacTableCsvRecord (schema)

Name	Description	Type	Notes
mac_address	The MAC address	string	Required
rtep_group_id	Remote tunnel endpoint(RTEP) group id RTEP group id is applicable when the logical switch is stretched across multiple sites. When rtep_group_id is set, mac_address represents remote mac_address.	integer
vtep_group_id	Virtual tunnel endpoint(VTEP) group id VTEP group id is applicable when the logical switch is stretched across multiple sites. When vtep_group_id is set, mac_address represents remote mac_address.	integer
vtep_ip	The virtual tunnel endpoint IP address	IPAddress
vtep_mac_address	The virtual tunnel endpoint MAC address	string

MacTableEntry (schema)

Name	Description	Type	Notes
mac_address	The MAC address	string	Required
rtep_group_id	Remote tunnel endpoint(RTEP) group id RTEP group id is applicable when the logical switch is stretched across multiple sites. When rtep_group_id is set, mac_address represents remote mac_address.	integer
vtep_group_id	Virtual tunnel endpoint(VTEP) group id VTEP group id is applicable when the logical switch is stretched across multiple sites. When vtep_group_id is set, mac_address represents remote mac_address.	integer
vtep_ip	The virtual tunnel endpoint IP address	IPAddress
vtep_mac_address	The virtual tunnel endpoint MAC address	string

ManagedResource (schema)

Base type for resources that are managed by API clients

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
resource_type	The type of this resource.	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ManagementConfig (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
publish_fqdns	True if Management nodes publish their fqdns(instead of default IP addresses) across NSX for its reachability.	boolean	Required

MandatoryAccessControlProperties (schema)

Information about mandatory access control

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
enabled	Enabled can be True/False	boolean
status	current status of Mandatory Access Control	string	Readonly Enum: ENABLED, DISABLED, ENABLED_PENDING_REBOOT

MetadataProxyConfig (schema)

Metadata Proxy Configuration

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
crypto_protocols	Metadata proxy supported cryptographic protocols The cryptographic protocols listed here are supported by the metadata proxy. TLSv1.1 and TLSv1.2 are supported by default	array of MetadataProxyCryptoProtocols
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
edge_cluster_path	Poilcy path to Edge Cluster Edge clusters configured on MP are auto-discovered by Policy and create corresponding read-only intent objects.	string	Required
enable_standby_relocation	Flag to enable standby relocation Only auto-placed metadata proxies are considered for relocation. Must be FALSE, when the preferred_edge_paths property is configured.	boolean	Default: "False"
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
preferred_edge_paths	Preferred Edge Paths Edge nodes should be members of edge cluster configured in edge_cluster_path.	array of string	Maximum items: 2
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value MetadataProxyConfig	string
secret	Secret Secret word or phrase to access metadata server.	string	Required
server_address	Server Address This field is a URL. Example formats - http://1.2.3.4:3888/path, http://text-md-proxy:5001/. Port number should be between 3000-9000.	string	Required
server_certificates	Policy paths to Certificate Authority (CA) certificates Valid certificates should be configured. The validity of certificates is not checked. Certificates are managed through /infra/certificates API on Policy.	array of string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

MetadataProxyCryptoProtocols (schema)

Metadata proxy supported cryptographic protocol

Name	Description	Type	Notes
MetadataProxyCryptoProtocols	Metadata proxy supported cryptographic protocol	string	Enum: TLS_V1, TLS_V1_1, TLS_V1_2 Default: "TLS_V1_2"

MirrorStackStatusListResult (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
overall_status	Overall mirror stack status for all the TNs SUCCESS if all the TN's stack status are SUCCESS, FAILED if some of the TN's stack status are FAILED.	MirrorStackStatusType	Required
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	All TN nodes in remote L3 mirror session mirror stack health status List all TN nodes which spaned in remote L3 mirror session mirror stack health status detailed info, including mirror stack status, vmknic status, TN node ID, TN node name and last updated status timestamp.	array of TnNodeStackSpanStatus	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

MirrorStackStatusType (schema)

Mirror stack status type

MirrorStackStatusType indicates the health result after user configured mirror stack
on L3PortMirrorSession.
When configure mirror stack on L3PortMirrorSession, it has two preconditions, ESXi
has been configured mirror stack and vmknic has been bounded to the stack.
SUCCESS means the host has mirror stack and vmknic has been bounded to the stack,
FAILED means either there is no mirror stack or the vmknic not bounded to it.

Name	Description	Type	Notes
MirrorStackStatusType	Mirror stack status type MirrorStackStatusType indicates the health result after user configured mirror stack on L3PortMirrorSession. When configure mirror stack on L3PortMirrorSession, it has two preconditions, ESXi has been configured mirror stack and vmknic has been bounded to the stack. SUCCESS means the host has mirror stack and vmknic has been bounded to the stack, FAILED means either there is no mirror stack or the vmknic not bounded to it.	string	Enum: UNKNOWN, SUCCESS, FAILED

MonitoringProfileBindingMap (schema)

Base Monitoring Profile Binding 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.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 MonitoringProfileBindingMap	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

MultiWidgetConfiguration (schema)

Multi-Widget

Combines two or more widgetconfigurations into a multi-widget

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
datasources	Array of Datasource Instances with their relative urls The 'datasources' represent the sources from which data will be fetched. Currently, only NSX-API is supported as a 'default' datasource. An example of specifying 'default' datasource along with the urls to fetch data from is given at 'example_request' section of 'CreateWidgetConfiguration' API.	array of Datasource	Minimum items: 0
default_filter_value	Default filter value to be passed to datasources Default filter values to be passed to datasources. This will be used when the report is requested without filter values.	array of DefaultFilterValue
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Widget Title Title of the widget. If display_name is omitted, the widget will be shown without a title.	string	Maximum length: 255
drilldown_id	Id of drilldown widget Id of drilldown widget, if any. Id should be a valid id of an existing widget. A widget is considered as drilldown widget when it is associated with any other widget and provides more detailed information about any data item from the parent widget.	string	Maximum length: 255
feature_set	Features required to view the widget Features required to view the widget.	FeatureSet
filter	Id of filter widget for subscription Id of filter widget for subscription, if any. Id should be a valid id of an existing filter widget. Filter widget should be from the same view. Datasource URLs should have placeholder values equal to filter alias to accept the filter value on filter change.	string
filter_value_required	Flag to indicate if filter value is necessary Flag to indicate that widget will continue to work without filter value. If this flag is set to false then default_filter_value is manadatory.	boolean	Default: "True"
footer		Footer
icons	Icons Icons to be applied at dashboard for widgets and UI elements.	array of Icon
id	Unique identifier of this resource	string	Sortable
is_drilldown	Set as a drilldown widget Set to true if this widget should be used as a drilldown.	boolean	Default: "False"
legend	Legend for the widget Legend to be displayed. If legend is not needed, do not include it.	Legend
navigation	Navigation to a specified UI page Hyperlink of the specified UI page that provides details.	string	Maximum length: 1024
resource_type	Must be set to the value MultiWidgetConfiguration	string	Required Readonly Enum: LabelValueConfiguration, DonutConfiguration, MultiWidgetConfiguration, ContainerConfiguration, StatsConfiguration, GridConfiguration, GraphConfiguration, CustomWidgetConfiguration, DropdownFilterWidgetConfiguration Maximum length: 255
shared	Visiblity of widgets to other users Please use the property 'shared' of View instead of this. The widgets of a shared view are visible to other users.	boolean	Deprecated
span	Horizontal span Represents the horizontal span of the widget / container.	int	Minimum: 1 Maximum: 12
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
weight	Weightage or placement of the widget or container Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details.	int	Deprecated
widgets	Widgets Array of widgets that are part of the multi-widget.	array of WidgetItem	Required Minimum items: 1 Maximum items: 2

NSXTConnectionInfo (schema)

NSX-T Connection Info

Credential info to connect to an NSX-T type of enforcement point.

Name	Description	Type	Notes
edge_cluster_ids	Edge Cluster IDs Edge Cluster UUIDs on enforcement point. Edge cluster information is required for creating logical L2, L3 constructs on enforcement point. Max 1 edge cluster ID. This is a deprecated property. The edge cluster id is now auto populated from enforcement point and its value can be read using APIs GET /infra/sites/site-id/enforcement-points/enforcementpoint-id/edge-clusters and GET /infra/sites/site-id/enforcement-points/enforcementpoint-1/edge-clusters/edge-cluster-id. The value passed through this property will be ignored.	array of string	Deprecated Maximum items: 1
enforcement_point_address	Enforcement Point Address Value of this property could be Hostname or IP. For instance: - On an NSX-T MP running on default port, the value could be "10.192.1.1" - On an NSX-T MP running on custom port, the value could be "192.168.1.1:32789" - On an NSX-T MP in VMC deployments, the value could be "192.168.1.1:5480/nsxapi"	string	Required
password	Password Password.	string
resource_type	Must be set to the value NSXTConnectionInfo	string	Required Enum: NSXTConnectionInfo, NSXVConnectionInfo, CvxConnectionInfo
thumbprint	Thumbprint of Enforcement Point Thumbprint of EnforcementPoint in the form of a SHA-256 hash represented in lower case HEX.	string
transport_zone_ids	Transport Zone IDs Transport Zone UUIDs on enforcement point. Transport zone information is required for creating logical L2, L3 constructs on enforcement point. Max 1 transport zone ID. This is a deprecated property. The transport zone id is now auto populated from enforcement point and its value can be read using APIs GET /infra/sites/site-id/enforcement-points/enforcementpoint-id/transport-zones and GET /infra/sites/site-id/enforcement-points/enforcementpoint-id/transport-zones/transport-zone-id. The value passed through this property will be ignored.	array of string	Deprecated Maximum items: 1
username	Username Username.	string

NSXVConnectionInfo (schema)

NSX-V Connection Info

Credential info to connect to an NSX-V type of enforcement point.

Name	Description	Type	Notes
enforcement_point_address	Enforcement Point Address Value of this property could be Hostname or IP. For instance: - On an NSX-T MP running on default port, the value could be "10.192.1.1" - On an NSX-T MP running on custom port, the value could be "192.168.1.1:32789" - On an NSX-T MP in VMC deployments, the value could be "192.168.1.1:5480/nsxapi"	string	Required
password	Password Password.	string	Required
resource_type	Must be set to the value NSXVConnectionInfo	string	Required Enum: NSXTConnectionInfo, NSXVConnectionInfo, CvxConnectionInfo
thumbprint	Thumbprint of Enforcement Point Thumbprint of EnforcementPoint in the form of a SHA-256 hash represented in lower case HEX.	string	Required
username	Username Username.	string	Required

NdSnoopingConfig (schema)

ND Snooping Configuration

Contains Neighbor Discovery Protocol (ND) snooping related configuration.

Name	Description	Type	Notes
nd_snooping_enabled	Is ND snooping enabled or not Enable this method will snoop the NS (Neighbor Solicitation) and NA (Neighbor Advertisement) messages in the ND (Neighbor Discovery Protocol) family of messages which are transmitted by a VM. From the NS messages, we will learn about the source which sent this NS message. From the NA message, we will learn the resolved address in the message which the VM is a recipient of. Addresses snooped by this method are subject to TOFU (Trust on First Use) policies as enforced by the system.	boolean	Default: "False"
nd_snooping_limit	Maximum number of ND (Neighbor Discovery Protocol) bindings Maximum number of ND (Neighbor Discovery Protocol) snooped IPv6 addresses	int	Minimum: 2 Maximum: 15 Default: "3"

NdpHeader (schema)

Neighbor discovery protocol header

Name	Description	Type	Notes
dst_ip	The destination IP address The IP address of the destination of the solicitation. It MUST NOT be a multicast address.	IPv6Address
msg_type	NDP message type This field specifies the type of the Neighbor discover message being sent. NEIGHBOR_SOLICITATION - Neighbor Solicitation message to discover the link-layer address of an on-link IPv6 node or to confirm a previously determined link-layer address. NEIGHBOR_ADVERTISEMENT - Neighbor Advertisement message in response to a Neighbor Solicitation message.	string	Enum: NEIGHBOR_SOLICITATION, NEIGHBOR_ADVERTISEMENT Default: "NEIGHBOR_SOLICITATION"

NestedExpression (schema)

NestedExpression

Nested expressions is a list of condition expressions that must follow the
below criteria:
0. Only allowed expressions in a NestedExpression are Condition and
ConjunctionOperator.
1. A non-empty expression list, must be of odd size. In a list, with
indices starting from 0, all condition expressions must be at even indices,
separated by the conjunction expressions AND at odd indices.
2. There may be at most 5 condition expressions inside a list.
3. NestedExpressions are homogeneous in nature, i.e, all expressions inside
a nested expression must have the same member type.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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 ExternalIDExpression IPAddressExpression IdentityGroupExpression MACAddressExpression NestedExpression PathExpression	Required Minimum items: 1
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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, ExternalIDExpression, PathExpression, IdentityGroupExpression
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

NestedServiceServiceEntry (schema)

A ServiceEntry that represents nesting service

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
nested_service_path	path of nested service	string	Required
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 NestedServiceServiceEntry	string	Required Enum: IPProtocolServiceEntry, IGMPTypeServiceEntry, ICMPTypeServiceEntry, ALGTypeServiceEntry, L4PortSetServiceEntry, EtherTypeServiceEntry, NestedServiceServiceEntry
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

NetworkError (schema)

Network Error

Network error related to container objects.

Name	Description	Type	Notes
error_code	Error code Error code of network related error.	string	Readonly
error_message	Error message Detailed message of network related error.	string	Readonly
spec	Other specifications Additional error information in json format.	string	Readonly

NewRole (schema)

New Role

Name	Description	Type	Notes
new_role_description	New role description	string
new_role_id	New role id	string	Required Pattern: "^[_a-z0-9-]+$"
new_role_name	New role name	string	Required

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

NodeAsyncReplicatorServiceProperties (schema)

Node service properties

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
service_name	Service name	string	Required
service_properties	Service properties	LoggingServiceProperties

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
lb_enable	Load Balancer enable flag	boolean
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

NodeGlobalManagerServiceProperties (schema)

Node service properties

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
service_name	Service name	string	Required
service_properties	Service properties	LoggingServiceProperties

NodeHttpServiceProperties (schema)

Node HTTP service properties

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
service_name	Service name	string	Required
service_properties	HTTP Service properties	HttpServiceProperties

NodeIdServicesMap (schema)

Name	Description	Type	Notes
node_id	NodeId	string	Required Maximum length: 255
service_types	List of ServiceTypes.	array of ServiceType	Required

NodeInfo (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
component_version	Component version of the node	string	Required Readonly
display_name	Name of the node	string	Required Readonly
id	UUID of node Identifier of the node	string	Required Readonly
type	Node type	string	Required Readonly

NodeInfoListRequestParameters (schema)

Name	Description	Type	Notes
component_type	Component type based on which nodes will be filtered	string
component_version	Component version based on which nodes will be filtered	string
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

NodeInfoListResult (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Paged Collection of Nodes	array of NodeInfo	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

NodeInstallUpgradeServiceProperties (schema)

Node install-upgrade service properties

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
service_name	Service name	string	Required
service_properties	install-upgrade Service properties	InstallUpgradeServiceProperties

NodeInterfaceStatisticsProperties (schema)

Node network interface statistic properties

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
interface_id	Interface ID	string
rx_bytes	Number of bytes received	integer
rx_dropped	Number of packets dropped	integer
rx_errors	Number of receive errors	integer
rx_frame	Number of framing errors	integer
rx_packets	Number of packets received	integer
source	Source of status data.	DataSourceType
tx_bytes	Number of bytes transmitted	integer
tx_carrier	Number of carrier losses detected	integer
tx_colls	Number of collisions detected	integer
tx_dropped	Number of packets dropped	integer
tx_errors	Number of transmit errors	integer
tx_packets	Number of packets transmitted	integer

NodeLogProperties (schema)

Node log properties

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
last_modified_time	Last modified time expressed in milliseconds since epoch	EpochMsTimestamp	Readonly
log_name	Name of log file	string	Readonly
log_size	Size of log file in bytes	integer	Readonly

NodeLogPropertiesListResult (schema)

Node log property query results

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Node log property results	array of NodeLogProperties	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

NodeNameServersProperties (schema)

Node network name servers properties

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
name_servers	Name servers	array of string	Required Maximum items: 3

NodeNetworkInterfaceProperties (schema)

Node network interface properties

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
admin_status	Interface administration status	string	Readonly Enum: up, down
bond_mode	Bond mode	string	Enum: ACTIVE_BACKUP, 802_3AD, ROUND_ROBIN, BROADCAST, XOR, TLB, ALB
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
is_kni	Interface is a KNI	boolean	Readonly
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, none
vlan	VLAN Id	integer	Readonly Minimum: 1 Maximum: 4094

NodeNetworkInterfacePropertiesListResult (schema)

Node network interface properties list results

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Node network interface property results	array of NodeNetworkInterfaceProperties	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

NodeNetworkProperties (schema)

Network configuration properties

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly

NodeNtpServiceProperties (schema)

Node NTP service properties

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
service_name	Service name	string	Required
service_properties	NTP Service properties	NtpServiceProperties

NodeProcessProperties (schema)

Node process properties

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cpu_time	CPU time (user and system) consumed by process in milliseconds	integer	Readonly
mem_resident	Resident set size of process in bytes	integer	Readonly
mem_used	Virtual memory used by process in bytes	integer	Readonly
pid	Process id	integer	Readonly
ppid	Parent process id	integer	Readonly
process_name	Process name	string	Readonly
start_time	Process start time expressed in milliseconds since epoch	EpochMsTimestamp	Readonly
uptime	Milliseconds since process started	integer	Readonly

NodeProcessPropertiesListResult (schema)

Node process property query results

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Node process property results	array of NodeProcessProperties	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

NodeProperties (schema)

Node properties

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cli_output_datetime	NSX CLI display datetime stamp in command output	boolean
cli_timeout	NSX CLI inactivity timeout, set to 0 to configure no timeout	integer	Minimum: 0
export_type	Export restrictions in effect, if any	string	Readonly Enum: RESTRICTED, UNRESTRICTED
fully_qualified_domain_name	Fully qualified domain name	string	Readonly
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	Readonly Maximum length: 36
node_version	Node version	string	Readonly
product_version	Product version	string	Readonly
system_datetime	System date time in UTC	DatetimeUTC
system_time	Current time expressed in milliseconds since epoch	EpochMsTimestamp	Readonly
timezone	Timezone	string

NodeProtonServiceProperties (schema)

Node service properties

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
service_name	Service name	string	Required
service_properties	Service properties	LoggingServiceProperties

NodeRouteProperties (schema)

Node network route properties

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
destination	Destination covered by route	string
from_address	From address	string	Pattern: "^[\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}$"
gateway	Address of next hop	string	Pattern: "^[\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}$"
interface_id	Network interface id of route	string
metric	Metric value of route	string
netmask	Netmask of destination covered by route	string	Pattern: "^[\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}$"
proto	Routing protocol identifier of route	string	Enum: unspec, redirect, kernel, boot, static, gated, ra, mrt, zebra, bird, dnrouted, xorp, ntk, dhcp Default: "boot"
route_id	Unique identifier for the route	string	Readonly
route_type	Route type	string	Required Enum: default, static, blackhole, prohibit, throw, unreachable
scope	Scope of destinations covered by route	string
src	Source address to prefer when sending to destinations of route	string	Pattern: "^[\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}$"

NodeRoutePropertiesListResult (schema)

Node network route properties list results

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Node route property results	array of NodeRouteProperties	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

NodeSearchDomainsProperties (schema)

Node network search domains properties

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
search_domains	Search domains	array of string	Required

NodeServiceProperties (schema)

Node service properties

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
service_name	Service name	string	Required

NodeServicePropertiesListResult (schema)

Node service property query results

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Node service property results	array of NodeServiceProperties	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

NodeServiceStatusProperties (schema)

Node service status properties

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
health	Service health in addition to runtime_state	string	Readonly Enum: STABLE, DEGRADED
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
reason	Reason for service degradation	string	Readonly
runtime_state	Service runtime state	string	Readonly Enum: running, stopped

NodeSnmpServiceProperties (schema)

Node SNMP service properties

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
service_name	Service name	string	Required
service_properties	SNMP Service properties	SnmpServiceProperties	Required

NodeSnmpV3EngineID (schema)

SNMP V3 Engine Id

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
service_name	Service name	string	Required
v3_engine_id	SNMP v3 engine id	string	Required

NodeSshServiceProperties (schema)

Node SSH service properties

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
service_name	Service name	string	Required
service_properties	SSH Service properties	SshServiceProperties

NodeStatusProperties (schema)

Node status properties

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cpu_cores	Number of CPU cores on the system	integer	Readonly
cpu_usage	CPU usage of DPDK and non-DPDK core groups Highest and average usage of DPDK and non-DPDK core of Edge Node.	CpuUsage	Readonly
disk_space_total	Amount of disk space available on the system, in kilobytes Amount of disk space available on the system, in kilobytes.	integer	Readonly
disk_space_used	Amount of disk space in use on the system, in kilobytes	integer	Readonly
dpdk_cpu_cores	Number of DPDK CPU cores on the system Number of DPDK cores on Edge Node which are used for packet IO processing.	integer	Readonly
edge_mem_usage	Memory usage of edge node Point in time usage of system, datapath, swap and cache memory in edge node. Valid only for Edge transport node.	EdgeTransportNodeMemoryUsage	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
non_dpdk_cpu_cores	Number of non-DPDK CPU cores on the system Number of non-DPDK cores on Edge Node.	integer	Readonly
source	Source of status data.	DataSourceType	Readonly
swap_total	Amount of disk available for swap, in kilobytes	integer	Readonly
swap_used	Amount of swap disk in use, in kilobytes	integer	Readonly
system_time	Current time expressed in milliseconds since epoch	EpochMsTimestamp	Readonly
uptime	Milliseconds since system start	integer	Readonly

NodeSummary (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
component_version	Component version	string	Required Readonly
node_count	Count of nodes Number of nodes of the type and at the component version	int	Required Readonly
type	Node type	string	Required Readonly

NodeSummaryList (schema)

Name	Description	Type	Notes
results	List of Node Summary	array of NodeSummary	Required

NodeSyslogExporterProperties (schema)

Node syslog exporter properties

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
exporter_name	Syslog exporter name	string	Required
facilities	Facilities to export	array of SyslogFacility
level	Logging level to export	string	Required Enum: EMERG, ALERT, CRIT, ERR, WARNING, NOTICE, INFO, DEBUG
msgids	MSGIDs to export	array of string
port	Port to export to, defaults to 514 for TCP, TLS, UDP protocols or 9000 for LI, LI-TLS protocols	integer	Minimum: 1 Maximum: 65535
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
tls_cert_pem	Certificate PEM of the rsyslog client	string
tls_client_ca_pem	CA certificate PEM of the rsyslog client	string
tls_key_pem	Private key PEM of the rsyslog client	string

NodeSyslogExporterPropertiesListResult (schema)

Node syslog exporter list results

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Node syslog exporter results	array of NodeSyslogExporterProperties	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

NodeTime (schema)

Node system time in UTC

Node system time in UTC

Name	Description	Type	Notes
system_datetime	Datetime string in UTC	DatetimeUTC	Required

NodeUserPasswordProperty (schema)

Name	Description	Type	Notes
password	The new password for user	string	Required

NodeUserProperties (schema)

Node user properties

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
full_name	Full name for the user	string
last_password_change	Number of days since password was last changed	integer	Readonly Minimum: 0 Maximum: 2147483647
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
password_change_frequency	Number of days password is valid before it must be changed Number of days password is valid before it must be changed. This can be set to 0 to indicate no password change is required or a positive integer up to 9999. By default local user passwords must be changed every 90 days.	integer	Minimum: 0 Maximum: 9999
status	User status Status of the user. This value can be ACTIVE indicating authentication attempts will be successful if the correct credentials are specified. The value can also be PASSWORD_EXPIRED indicating authentication attempts will fail because the user's password has expired and must be changed. Or, this value can be NOT_ACTIVATED indicating the user's password has not yet been set and must be set before the user can authenticate.	string	Readonly Enum: ACTIVE, PASSWORD_EXPIRED, NOT_ACTIVATED
userid	Numeric id for the user	integer	Readonly Minimum: 0 Maximum: 2147483647
username	User login name (must be "root" if userid is 0)	string	Minimum length: 1 Maximum length: 32 Pattern: "^[a-zA-Z][a-zA-Z0-9@-_.\-]*$"

NodeUserPropertiesListResult (schema)

Node users list results

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	List of node users	array of NodeUserProperties	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

NodeVersion (schema)

Name	Description	Type	Notes
node_version	Node version	string	Readonly
product_version	Product version	string	Readonly

NsxRole (schema)

Role

Name	Description	Type	Notes
permissions	Permissions Please use the /user-info/permissions api to get the permission that the user has on each feature.	array of string	Deprecated Enum: read-api, read-write-api, crud, read, execute, none
role	Role ID This field represents the identifier of the role. With the introduction of custom roles, this field is no longer an enum.	string	Required

NsxTDNSForwarderStatistics (schema)

Statistics counters of the DNS forwarder

The current statistics counters of the DNS forwarder including cache usages
and query numbers per forwarders, on an NSX-T type of enforcement point.

Name	Description	Type	Notes
cached_entries	The total number of cached entries	integer	Readonly
conditional_forwarder_statistics	The statistics of conditional forwarder zones	array of NsxTDNSForwarderZoneStatistics	Readonly Minimum items: 0 Maximum items: 5
configured_cache_size	The configured cache size, in kb	integer	Readonly
default_forwarder_statistics	The statistics of default forwarder zone	NsxTDNSForwarderZoneStatistics	Readonly
enforcement_point_path	Enforcement point path Policy path referencing the enforcement point from where the statistics are fetched.	string	Readonly
queries_answered_locally	The total number of queries answered from local cache	integer	Readonly
queries_forwarded	The total number of forwarded DNS queries	integer	Readonly
resource_type	Must be set to the value NsxTDNSForwarderStatistics	string	Required Enum: NsxTDNSForwarderStatistics
timestamp	Time stamp of the current statistics, in ms	EpochMsTimestamp	Readonly
total_queries	The total number of received DNS queries	integer	Readonly
used_cache_statistics	The statistics of used cache	array of NsxTPerNodeUsedCacheStatistics	Readonly Minimum items: 0 Maximum items: 2

NsxTDNSForwarderStatus (schema)

The current runtime status of DNS forwarder

The current runtime status of the DNS forwarder.

Name	Description	Type	Notes
enforcement_point_path	Enforcement point path Policy path referencing the enforcement point from where the status is fetched.	string	Readonly
extra_message	Extra message, if available	string	Readonly
resource_type	Must be set to the value NsxTDNSForwarderStatus	string	Required Enum: NsxTDNSForwarderStatus
status	UP means the DNS forwarder is working correctly on the active transport node and the stand-by transport node (if present). Failover will occur if either node goes down. DOWN means the DNS forwarder is down on both active transport node and standby node (if present). The DNS forwarder does not function in this situation. Error means there is some error on one or both transport node, or no status was reported from one or both transport nodes. The DNS forwarder may be working (or not working). NO_BACKUP means DNS forwarder is working in only one transport node, either because it is down on the standby node, or no standby is configured. An forwarder outage will occur if the active node goes down.	string	Readonly Enum: UP, DOWN, ERROR, NO_BACKUP, UNKNOWN
timestamp	Time stamp of the current status, in ms	EpochMsTimestamp	Readonly

NsxTDNSForwarderZoneStatistics (schema)

Statistics counters of the DNS forwarder zone

Statistics counters of the DNS forwarder zone.

Name	Description	Type	Notes
domain_names	Domain names configured for the forwarder Domain names configured for the forwarder. Empty if this is the default forwarder.	array of string	Readonly Minimum items: 0 Maximum items: 100
upstream_statistics	Statistics per upstream server.	array of NsxTUpstreamServerStatistics	Readonly Minimum items: 0 Maximum items: 3

NsxTDnsAnswer (schema)

Answer of dns nslookup

Name	Description	Type	Notes
authoritative_answers	Authoritative answers	array of NsxTDnsQueryAnswer	Minimum items: 1 Maximum items: 256
dns_server	Dns server information Dns server ip address and port, format is "ip address#port".	string	Required
edge_node_id	Edge node id ID of the edge node that performed the query.	string	Required
enforcement_point_path	Enforcement point path Policy path referencing the enforcement point from where the DNS forwarder nslookup answer is fetched.	string	Readonly
non_authoritative_answers	Non authoritative answers	array of NsxTDnsQueryAnswer	Minimum items: 1 Maximum items: 256
raw_answer	Raw message returned from the dns forwarder It can be NXDOMAIN or error message which is not consisted of authoritative_answer or non_authoritative_answer.	string
resource_type	Must be set to the value NsxTDnsAnswer	string	Required Enum: NsxTDnsAnswer

NsxTDnsQueryAnswer (schema)

Answer of nslookup

Name	Description	Type	Notes
address	Matched ip address Resolved IP address matched with the nslookup address provided as a request parameter.	string
name	Matched name Matched name of the given address.	string

NsxTPerNodeUsedCacheStatistics (schema)

Per node used cache query statistics counters

Query statistics counters of used cache from node

Name	Description	Type	Notes
cached_entries	The total number of cached entries	integer	Readonly
node_id	UUID of active/standby transport node	string	Readonly
used_cache_size	The memory size used in cache, in kb	integer	Readonly

NsxTUpstreamServerStatistics (schema)

Upstream server query statistics counters

Query statistics counters to an upstream server including successfully
forwarded queries and failed queries.

Name	Description	Type	Notes
queries_failed	Queries failed to forward.	integer	Readonly
queries_succeeded	Queries forwarded successfully	integer	Readonly
upstream_server	Upstream server ip	IPAddress	Readonly

NtpServiceProperties (schema)

NTP Service properties

Name	Description	Type	Notes
servers	NTP servers	array of HostnameOrIPv4Address	Required
start_on_boot	Start NTP service when system boots	boolean	Default: "True"

ObjectRolePermissionGroup (schema)

RBAC Objects qualifier

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
inheritance_disabled	Does children of this object inherit this rule	boolean	Default: "False"
operation	Allowed operation	string	Enum: crud, read, execute, none
path_prefix	Path prefix	string	Required
resource_type	Must be set to the value ObjectRolePermissionGroup	string
role_name	Role name	string	Required
rule_disabled	Is rule disabled or not	boolean	Default: "False"
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

ObjectRolePermissionGroupListRequestParameters (schema)

RBAC Objects qualifier

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
inheritance_disabled	Does children of this object inherit this rule	boolean	Default: "False"
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
path_prefix	Path prefix	string
role_name	Role name	string
sort_ascending		boolean
sort_by	Field by which records are sorted	string

ObjectRolePermissionGroupListResult (schema)

Paged collection of RBAC Objects

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	ObjectRolePermissionGroup list results	array of ObjectRolePermissionGroup	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

OnboardingAttribute (schema)

Config Onboarding Attributes

Generic config onboarding attributes in form attribute name and its
corresponding values.

Name	Description	Type	Notes
name	Attribute name	string	Required Readonly
value	Attribute value	string	Readonly
value_type	Attribute Type	string	Readonly Enum: STRING, INTEGER, BOOLEAN Default: "STRING"

OnboardingCompatibilityStatus (schema)

Onboarding Compatibility Status

Name	Description	Type	Notes
OnboardingCompatibilityStatus	Onboarding Compatibility Status	string	Enum: COMPATIBLE, INCOMPATIBLE

OnboardingConflictStatus (schema)

Onboarding Conflict Status

Name	Description	Type	Notes
OnboardingConflictStatus	Onboarding Conflict Status	string	Enum: NO_CONFLICTS, CONFLICT_DETECTED

OnboardingFeatureInfo (schema)

Onboarding Feature Information

Feature information currently under process or refered to.

Name	Description	Type	Notes
name	Feature Name	string	Readonly
path	Resource Path	string	Readonly
resource_type	Resource Type	string	Readonly

OnboardingStage (schema)

Config onboarding stage

Represents intermediate on-boarding stages on global manager or
corresponding site manager.

Name	Description	Type	Notes
OnboardingStage	Config onboarding stage Represents intermediate on-boarding stages on global manager or corresponding site manager.	string	Enum: LM_MIGRATION, LM_SYNCHRONIZATION, GM_PERSISTENCE, GM_TRANSFORMATION, GM_PROCESSING_DONE, GM_ROLLBACK, GM_ROLLBACK_DONE

OnboardingStatus (schema)

Onboarding Status

Name	Description	Type	Notes
OnboardingStatus	Onboarding Status	string	Enum: ALLOWED, BLOCKED_FEATURE_CHECK, BLOCKED_CONFIG_CONFLICT_CHECK, BLOCKED_SITE_RESTORE_PENDING, BLOCKED_FULLSYNC_PENDING, BLOCKED_USER_REJECT, BLOCKED_SITE_NOT_REACHABLE, CONTINUE_RESOLUTION_NEEDED, IN_PROGRESS, FAILED_GM_ROLLBACK_IN_PROGRESS, SUCCESS

OpenLdapIdentitySource (schema)

An OpenLDAP identity source service

An identity source service that runs OpenLDAP. The service allows selected user accounts defined in OpenLDAP to log into and access NSX-T.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
alternative_domain_names	Additional domains to be directed to this identity source After parsing the "user@domain", the domain portion is used to select the LDAP identity source to use. Additional domains listed here will also be directed to this LDAP identity source. In Active Directory these are sometimes referred to as Alternative UPN Suffixes.	array of string
base_dn	DN of subtree for user and group searches The subtree of the LDAP identity source to search when locating users and groups.	string	Required
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
domain_name	Authentication domain name The name of the authentication domain. When users log into NSX using an identity of the form "user@domain", NSX uses the domain portion to determine which LDAP identity source to use.	string	Required
id	Unique identifier of this resource	string	Sortable
ldap_servers	LDAP servers for this identity source The list of LDAP servers that provide LDAP service for this identity source. Currently, only one LDAP server is supported.	array of IdentitySourceLdapServer	Maximum items: 1
resource_type	Must be set to the value OpenLdapIdentitySource	string	Required Enum: ActiveDirectoryIdentitySource, OpenLdapIdentitySource
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

OverriddenResource (schema)

Represents overridden resource information for federated entity.

Represents which federated global resources have been overrriden on
a specific Site.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
intent_path	Policy resource path of the overridden resource Policy resource path of the overridden resource.	string	Readonly
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 OverriddenResource	string
site_path	Site path Site path to the specific site that has overridden the global resource.	string	Readonly
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

OverriddenResourceListResult (schema)

Paged Collection of OverriddenResource

Paged Collection of OverriddenResource.

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	OverriddenResource list results OverriddenResource list results.	array of OverriddenResource	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

OverrideDeleteRequestParameters (schema)

Override 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"
override	Delete the locally overriden global object If true, the overridden object can be deleted locally. This will restore the global resource as the intended configuration for this site.	boolean	Default: "False"

OverrideListRequestParameters (schema)

Override list request parameters

Parameter to filter overridden resource list by intent path or site path or both.

Name	Description	Type	Notes
intent_path	Global resource path	string
site_path	Site path	string

OverrideRequestParameters (schema)

Override request parameters

Name	Description	Type	Notes
override	Locally override the global object If true, the global resource can be over written locally. This means that there will be a local only resource in place of the global resource that can reflect local specific settings and values. The global object will continue to exist but will not be used for any configuration until this local object is removed. When the object is overridden the Global resource continues to exist unmodified, while the overridden object is created with all of the user specified values. The Global resource may be updated in the background, however, the overridden object may only be updated by the user. Once the user removes the overridden copy, the Global resource will then resume being used in the configuration.	boolean	Default: "False"

PackageLoggingLevels (schema)

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

PacketAddressClassifier (schema)

Address classifications for a packet

A packet is classified to have an address binding, if its address
configuration matches with all user specified properties.

Name	Description	Type	Notes
ip_address	A single IP address or a subnet, e.g. x.x.x.x or x.x.x.x/y	IPElement
mac_address	A single MAC address	MACAddress
vlan		VlanID

PacketData (schema)

This is an abstract type. Concrete child types:
BinaryPacketData
FieldsPacketData

Name	Description	Type	Notes
frame_size	Requested total size of the (logical) packet in bytes If the requested frame_size is too small (given the payload and traceflow metadata requirement of 16 bytes), the traceflow request will fail with an appropriate message. The frame will be zero padded to the requested size.	integer	Minimum: 60 Maximum: 1000 Default: "128"
resource_type	Packet configuration	string	Required Enum: BinaryPacketData, FieldsPacketData Default: "FieldsPacketData"
routed	A flag, when set true, indicates that the traceflow packet is of L3 routing.	boolean
transport_type	transport type of the traceflow packet	string	Enum: BROADCAST, UNICAST, MULTICAST, UNKNOWN Default: "UNICAST"

PacketTypeAndCounter (schema)

Name	Description	Type	Notes
counter	The number of packets.	integer	Required
packet_type	The type of the packets	string	Required

PacketsDroppedBySecurity (schema)

Name	Description	Type	Notes
bpdu_filter_dropped	The number of packets dropped by "BPDU filter".	integer
dhcp_client_dropped_ipv4	The number of IPv4 packets dropped by "DHCP client block".	integer
dhcp_client_dropped_ipv6	The number of IPv6 packets dropped by "DHCP client block".	integer
dhcp_server_dropped_ipv4	The number of IPv4 packets dropped by "DHCP server block".	integer
dhcp_server_dropped_ipv6	The number of IPv6 packets dropped by "DHCP server block".	integer
spoof_guard_dropped	The packets dropped by "Spoof Guard"; supported packet types are IPv4, IPv6, ARP, ND, non-IP.	array of PacketTypeAndCounter

PartialPatchConfig (schema)

Contains configuration for Partial patch.

This object allows enabling or disabling of partial patch functionality.
Enabling partial patch allows patching of a subset of the fields of any object.
After enabling partial patching, any object payload provided will be merged with the existing object payload.
Note that while all mandatory fields are expected to be provided during the creation of any object,
enabling partial patch will allow patching of existing objects with a subset of mandatory fields.

Name	Description	Type	Notes
enable_partial_patch	This object will contain the partial patch configuration. boolean value used to enable/disable partial patch	boolean	Required

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

PatchResources (schema)

Patch Resources

Patch Resources is an action to create/patch resources in response to an event.

Name	Description	Type	Notes
body	Body Patch body representing a Hierarchical Patch payload. The resources included in the body are patched replacing the injections' keys with their actual values.	object	Required
injections	Injections Injections holding keys (variables) and their corresponding values.	array of Injection	Minimum items: 1
resource_type	Must be set to the value PatchResources	string	Required Enum: PatchResources, SetFields

PathExpression (schema)

Path expression node

Represents policy path expressions in the form of an array, to support addition of objects like groups, segments and policy logical ports 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.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
paths	Array of policy paths This array can consist of one or more policy paths. Only policy paths of groups, segments and policy logical ports are allowed.	array of string	Required Minimum items: 1
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value PathExpression	string	Required Enum: Condition, ConjunctionOperator, NestedExpression, IPAddressExpression, MACAddressExpression, ExternalIDExpression, PathExpression, IdentityGroupExpression
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

PathPermissionGroup (schema)

RBAC Objects qualifier

Name	Description	Type	Notes
object_path	Full Object Path	string	Required
operation	Allowed operation	string	Required Enum: crud, read, execute, none

PeerCertificateChain (schema)

A peer's certificate chain

The certificate chain presented by a remote TLS service.

Name	Description	Type	Notes
details	List of X509Certificates.	array of X509Certificate	Readonly
pem_encoded	PEM encoded certificate data.	string	Required

PendingChangesInfoNsxT (schema)

NSX-T Pending Change Info

Information about recent changes, if any, that are not reflected in the Enforced Realized Status.

Name	Description	Type	Notes
pending_changes_flag	Pending Changes Flag Flag describing whether there are any pending changes that are not reflected in the status.	boolean	Readonly

PerStepRestoreStatus (schema)

Restore step status

Name	Description	Type	Notes
description	A description of the restore status	string	Required Readonly
value	Per step restore status value	string	Required Readonly Enum: INITIAL, RUNNING, SUSPENDED_BY_USER, SUSPENDED_FOR_USER_ACTION, FAILED, SUCCESS

PlainFilterData (schema)

Name	Description	Type	Notes
basic_filter	Basic RCF rule for packet filter	string
extend_filter	Extended RCF rule for packet filter	string
resource_type	Must be set to the value PlainFilterData	string	Required Enum: FieldsFilterData, PlainFilterData Default: "FieldsFilterData"

PointDefinition (schema)

Definition of a point of graph

Defines the point of a graph.

Name	Description	Type	Notes
drilldown_id	Id of drilldown widget Id of drilldown widget, if any. Id should be a valid id of an existing widget. A widget is considered as drilldown widget when it is associated with any other widget and provides more detailed information about any data item from the parent widget.	string
field	Expression for points of the graph An expression that represents the points of the graph	string	Required
navigation	Navigation to a specified UI page Hyperlink of the specified UI page that provides details.	string	Maximum length: 1024
tooltip	Multi-line tooltip Multi-line text to be shown on tooltip while hovering over the point of a graph.	array of Tooltip	Minimum items: 0
x_value	Variable chosen for X value of the point of the graph Represents the variable for the X value of points that are plotted on the graph.	string	Required
y_value	Variable chosen for Y value of the point of the graph Represents the variable for the Y value of points that are plotted on the graph.	string	Required

Policy (schema)

Contains ordered list of Rules

Ordered list of Rules. 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.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
category	A way to classify a security policy, if needed. - Distributed Firewall - Policy framework provides five pre-defined categories for classifying a security policy. They are "Ethernet","Emergency", "Infrastructure" "Environment" and "Application". There is a pre-determined order in which the policy framework manages the priority of these security policies. Ethernet category is for supporting layer 2 firewall rules. The other four categories are applicable for layer 3 rules. Amongst them, the Emergency category has the highest priority followed by Infrastructure, Environment and then Application rules. Administrator can choose to categorize a security policy into the above categories or can choose to leave it empty. If empty it will have the least precedence w.r.t the above four categories. - Edge Firewall - Policy Framework for Edge Firewall provides six pre-defined categories "Emergency", "SystemRules", "SharedPreRules", "LocalGatewayRules", "AutoServiceRules" and "Default", in order of priority of rules. All categories are allowed for Gatetway Policies that belong to 'default' Domain. However, for user created domains, category is restricted to "SharedPreRules" or "LocalGatewayRules" only. Also, the users can add/modify/delete rules from only the "SharedPreRules" and "LocalGatewayRules" categories. If user doesn't specify the category then defaulted to "Rules". System generated category is used by NSX created rules, for example BFD rules. Autoplumbed category used by NSX verticals to autoplumb data path rules. Finally, "Default" category is the placeholder default rules with lowest in the order of priority.	string
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
comments	SecurityPolicy lock/unlock comments Comments for security policy lock/unlock.	string
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
internal_sequence_number	Internal sequence number This field is to indicate the internal sequence number of a policy with respect to the policies across categories.	int	Readonly
is_default	Default policy flag A flag to indicate whether policy is a default policy.	boolean	Readonly
lock_modified_by	User who locked the security policy ID of the user who last modified the lock for the secruity policy.	string	Readonly
lock_modified_time	SecuirtyPolicy locked/unlocked time SecurityPolicy locked/unlocked time in epoch milliseconds.	EpochMsTimestamp	Readonly
locked	Lock a security policy Indicates whether a security policy should be locked. If the security policy is locked by a user, then no other user would be able to modify this security policy. Once the user releases the lock, other users can update this security policy.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 Policy	string
rule_count	Rule count The count of rules in the policy.	int	Readonly
scheduler_path	Path to the scheduler for time based scheduling Provides a mechanism to apply the rules in this policy for a specified time duration.	string
scope	The list of group paths where the rules in this policy will get applied. This scope will take precedence over rule level scope. Supported only for security and redirection policies. In case of RedirectionPolicy, it is expected only when the policy is NS and redirecting to service chain.	array of string	Maximum items: 128
sequence_number	Sequence number to resolve conflicts across Domains This field is used to resolve conflicts between security policies across domains. In order to change the sequence number of a policy one can fire a POST request on the policy entity with a query parameter action=revise The sequence number field will reflect the value of the computed sequence number upon execution of the above mentioned POST request. For scenarios where the administrator is using a template to update several security policies, the only way to set the sequence number is to explicitly specify the sequence number for each security policy. If no sequence number is specified in the payload, a value of 0 is assigned by default. If there are multiple policies with the same sequence number then their order is not deterministic. If a specific order of policies is desired, then one has to specify unique sequence numbers or use the POST request on the policy entity with a query parameter action=revise to let the framework assign a sequence number	int	Minimum: 0
stateful	Stateful nature of the entries within this security policy. Stateful or Stateless nature of security policy is enforced on all rules in this security policy. When it is stateful, the state of the network connects are tracked and a stateful packet inspection is performed. Layer3 security policies can be stateful or stateless. By default, they are stateful. Layer2 security policies can only be stateless.	boolean
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
tcp_strict	Enforce strict tcp handshake before allowing data packets Ensures that a 3 way TCP handshake is done before the data packets are sent. tcp_strict=true is supported only for stateful security policies. If the tcp_strict flag is not specified and the security policy is stateful, then tcp_strict will be set to true.	boolean
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

PolicyAlarmResource (schema)

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.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
error_details	Detailed information about errors from an API call made to the enforcement point, if any.	PolicyApiError
id	Unique identifier of this resource	string	Sortable
message	error message to describe the issue	string
parent_path	Path of its parent Path of its parent	string	Readonly
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 PolicyAlarmResource	string
source_reference	path of the object on which alarm is created	string
source_site_id	source site(LM) id. This field will refer to the source site on which the alarm is generated. This field is populated by GM, when it receives corresponding notification from LM.	string	Readonly
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

PolicyAlarmResourceListRequestParameters (schema)

PolicyAlarmResource list request parameters

PolicyAlarmResource list request parameters

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

PolicyAlarmResourceListResult (schema)

PolicyAlarmResource list result

PolicyAlarmResource list result

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Paged Collection of PolicyAlarmResources List of alarm resources	array of PolicyAlarmResource
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

PolicyApiError (schema)

Detailed information about an API Error

Name	Description	Type	Notes
details	Further details about the error	string
error_code	A numeric error code	integer
error_data	Additional data about the error	object
error_message	A description of the error	string
module_name	The module name where the error occurred	string
related_errors	Other errors related to this error	array of PolicyRelatedApiError

PolicyArpProxyEntry (schema)

Name	Description	Type	Notes
arp_proxy_ip	Array of ARP proxy service address ARP proxy information for a service with ip.	array of IPAddress	Readonly
service_id	Service type id Identifier of connected service on port.	string	Readonly

PolicyArpProxyTableListResult (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Paginated list of Gateway interface ARP proxy tables	array of InterfaceArpProxy	Readonly
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

PolicyAttributes (schema)

Policy Attributes data holder

Name	Description	Type	Notes
attribute_source	Source of attribute value i.e whether system defined or custom value	string	Enum: SYSTEM, CUSTOM Default: "SYSTEM"
datatype	Datatype for attribute	string	Required Enum: STRING
description	Description for attribute value	string
isALGType	Is the value ALG type Describes whether the APP_ID value is ALG type or not.	boolean
key	Key for attribute URL_Reputation is currently not available. Please do not use it in Attribute Key while creating context profile	string	Required Enum: APP_ID, DOMAIN_NAME, URL_CATEGORY, URL_REPUTATION
metadata	Provide additional meta information about key/values This is optional part that can hold additional data about the attribute key/values. Example - For URL CATEGORY key , it specified super category for url category value. This is generic array and can hold multiple meta information about key/values in future	array of ContextProfileAttributesMetadata
sub_attributes	Reference to sub attributes for the attribute	array of PolicySubAttributes
value	Value for attribute key Multiple attribute values can be specified as elements of array.	array of string	Required Minimum items: 1

PolicyBasedIPSecVpnSession (schema)

Policy based VPN session

A Policy Based VPN requires to define protect rules that match local and peer subnets. IPSec security associations is negotiated for each pair of local and peer subnet.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
authentication_mode	Authentication Mode Peer authentication mode. PSK - In this mode a secret key shared between local and peer sites is to be used for authentication. The secret key can be a string with a maximum length of 128 characters. CERTIFICATE - In this mode a certificate defined at the global level is to be used for authentication.	string	Enum: PSK, CERTIFICATE Default: "PSK"
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
compliance_suite	Compliance suite Compliance suite.	string	Enum: CNSA, SUITE_B_GCM_128, SUITE_B_GCM_256, PRIME, FOUNDATION, FIPS, NONE
connection_initiation_mode	Connection initiation mode Connection initiation mode used by local endpoint to establish ike connection with peer site. INITIATOR - In this mode local endpoint initiates tunnel setup and will also respond to incoming tunnel setup requests from peer gateway. RESPOND_ONLY - In this mode, local endpoint shall only respond to incoming tunnel setup requests. It shall not initiate the tunnel setup. ON_DEMAND - In this mode local endpoint will initiate tunnel creation once first packet matching the policy rule is received and will also respond to incoming initiation request.	string	Enum: INITIATOR, RESPOND_ONLY, ON_DEMAND Default: "INITIATOR"
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
dpd_profile_path	Dead peer detection (DPD) profile path Policy path referencing Dead Peer Detection (DPD) profile. Default is set to system default profile.	string
enabled	Enable/Disable IPSec VPN session Enable/Disable IPSec VPN session.	boolean	Default: "True"
id	Unique identifier of this resource	string	Sortable
ike_profile_path	Internet key exchange (IKE) profile path Policy path referencing IKE profile to be used. Default is set according to system default profile.	string
local_endpoint_path	Local endpoint path Policy path referencing Local endpoint.	string	Required
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
peer_address	IPV4 address of peer endpoint on remote site Public IPV4 address of the remote device terminating the VPN connection.	string	Required
peer_id	Peer id Peer ID to uniquely identify the peer site. The peer ID is the public IP address of the remote device terminating the VPN tunnel. When NAT is configured for the peer, enter the private IP address of the peer.	string	Required
psk	Pre-shared key IPSec Pre-shared key. Maximum length of this field is 128 characters.	string
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value PolicyBasedIPSecVpnSession	IPSecVpnSessionResourceType	Required
rules	Rules	array of IPSecVpnRule	Required Minimum items: 1
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
tcp_mss_clamping	TCP MSS Clamping TCP Maximum Segment Size Clamping Direction and Value.	TcpMaximumSegmentSizeClamping
tunnel_profile_path	IPSec tunnel profile path Policy path referencing Tunnel profile to be used. Default is set to system default profile.	string
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

PolicyBasedL3VpnSession (schema) (Deprecated)

Policy based L3Vpn Session

A Policy-based L3Vpn session is a configuration in which a specific vpn tunnel is
referenced in a policy whose action is set as tunnel.

Name	Description	Type	Notes
resource_type	Must be set to the value PolicyBasedL3VpnSession	L3VpnSessionResourceType	Required
rules	L3Vpn Rules L3Vpn rules that are specific to the L3Vpn. Only L3Vpn rules with PROTECT action are supported.	array of L3VpnRule

PolicyBgpNeighborStatus (schema)

Name	Description	Type	Notes
address_families	Address families of BGP neighbor Address families of BGP neighbor	array of BgpAddressFamily	Readonly
announced_capabilities	BGP capabilities sent to BGP neighbor.	array of string	Readonly
connection_drop_count	Count of connection drop	integer	Readonly
connection_state	Current state of the BGP session.	string	Readonly Enum: INVALID, IDLE, CONNECT, ACTIVE, OPEN_SENT, OPEN_CONFIRM, ESTABLISHED, UNKNOWN
edge_path	Transport node policy path	string
established_connection_count	Count of connections established	integer	Readonly
graceful_restart_mode	Graceful restart mode Current state of graceful restart of BGP neighbor. Possible values are - 1. GR_AND_HELPER - Graceful restart with Helper 2. HELPER_ONLY - Helper only 3. DISABLE - Disabled	string	Readonly
hold_time	Time in ms to wait for HELLO from BGP peer. If a HELLO packet is not seen from BGP Peer withing hold_time then BGP neighbor will be marked as down.	integer	Readonly
keep_alive_interval	Time in ms to wait for HELLO packet from BGP peer	integer	Readonly
last_update_timestamp	Timestamp indicating last update time of data Timestamp when the data was last updated, unset if data source has never updated the data.	EpochMsTimestamp	Readonly
local_port	TCP port number of Local BGP connection	integer	Readonly Minimum: 1 Maximum: 65535
messages_received	Count of messages received from the neighbor	integer	Readonly
messages_sent	Count of messages sent to the neighbor	integer	Readonly
negotiated_capability	BGP capabilities negotiated with BGP neighbor.	array of string	Readonly
neighbor_address	The IP of the BGP neighbor	IPAddress	Readonly
neighbor_router_id	Router ID of the BGP neighbor.	string	Readonly
remote_as_number	AS number of the BGP neighbor	string	Readonly
remote_port	TCP port number of remote BGP Connection	integer	Readonly Minimum: 1 Maximum: 65535
remote_site	Remote site Remote site details.	ResourceReference	Readonly
source_address	The Ip address of logical port	IPAddress	Readonly
tier0_path	Policy path to Tier0	string	Required Readonly
time_since_established	Time(in seconds) since connection was established.	integer	Readonly
total_in_prefix_count	Count of in prefixes Sum of in prefixes counts across all address families.	integer	Readonly
total_out_prefix_count	Count of out prefixes Sum of out prefixes counts across all address families.	integer	Readonly

PolicyBgpNeighborsStatusListResult (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Status of BGP neighbors of the Tier0	array of PolicyBgpNeighborStatus	Readonly
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

PolicyComplianceStatus (schema)

Name	Description	Type	Notes
last_updated_time	Timestamp of last update	EpochMsTimestamp	Readonly
non_compliant_configs	List of non compliant configuration and impacted services	array of PolicyNonCompliantConfig	Readonly

PolicyConfigResource (schema)

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.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

PolicyContextProfile (schema)

Policy Context Profile entity

An entity that encapsulates attributes and sub-attributes of various
network services (eg. L7 services, domain name, encryption algorithm)
The entity will be consumed in firewall rules and can be added in new
tuple called profile in firewall rules. To get a list of supported
attributes and sub-attributes fire the following REST API
GET https://<policy-mgr>/policy/api/v1/infra/context-profiles/attributes

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
attributes	Array of Policy Context Profile attributes Property containing attributes/sub-attributes for Policy Context Profile.	array of PolicyAttributes	Required
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 PolicyContextProfile	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

PolicyContextProfileDeleteRequestParameters (schema)

Policy Context Profile 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"
override	Delete the locally overriden global object If true, the overridden object can be deleted locally. This will restore the global resource as the intended configuration for this site.	boolean	Default: "False"

PolicyContextProfileListRequestParameters (schema)

Policy Context Profile 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
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

PolicyContextProfileListResult (schema)

List result of PolicyContextProfiles

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Paged collection of PolicyContextProfiles	array of PolicyContextProfile	Readonly
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

PolicyDHGroup (schema) (Deprecated)

Diffie-Hellman groups

Diffie-Hellman groups represent algorithm used to derive shared keys between
IPSec VPN initiator and responder over an unsecured network.
GROUP2 uses 1024-bit Modular Exponentiation (MODP) group.
GROUP5 uses 1536-bit MODP group.
GROUP14 uses 2048-bit MODP group.
GROUP15 uses 3072-bit MODP group.
GROUP16 uses 4096-bit MODP group.

Name	Description	Type	Notes
PolicyDHGroup	Diffie-Hellman groups Diffie-Hellman groups represent algorithm used to derive shared keys between IPSec VPN initiator and responder over an unsecured network. GROUP2 uses 1024-bit Modular Exponentiation (MODP) group. GROUP5 uses 1536-bit MODP group. GROUP14 uses 2048-bit MODP group. GROUP15 uses 3072-bit MODP group. GROUP16 uses 4096-bit MODP group.	string	Deprecated Enum: GROUP2, GROUP5, GROUP14, GROUP15, GROUP16

PolicyDnsAnswerPerEnforcementPoint (schema)

NSLookup answer per enforcement point

DNS forwarder nslookup answer per enforcement point.

Name	Description	Type	Notes
enforcement_point_path	Enforcement point path Policy path referencing the enforcement point from where the DNS forwarder nslookup answer is fetched.	string	Readonly
resource_type	Resource type Resource type of the DNS forwarder nslookup answer.	string	Required Enum: NsxTDnsAnswer

PolicyDnsForwarder (schema)

DNS Forwarder

Used to configure DNS Forwarder

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
conditional_forwarder_zone_paths	Path of conditional DNS zones Max of 5 DNS servers can be configured	array of string	Maximum items: 5
default_forwarder_zone_path	Path of the default DNS zone. This is the zone to which DNS requests are forwarded by default	string	Required
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
enabled	DNS forwarder enabled flag The flag, which suggests whether the DNS forwarder is enabled or disabled. The default is True.	boolean	Default: "True"
id	Unique identifier of this resource	string	Sortable
listener_ip	IP on which the DNS Forwarder listens. This is the IP on which the DNS Forwarder listens.	IPv4Address	Required
log_level	Log level of the dns forwarder Set log_level to DISABLED will stop dumping fowarder log.	string	Enum: DEBUG, INFO, WARNING, ERROR, FATAL Default: "INFO"
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 PolicyDnsForwarder	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

PolicyDnsForwarderZone (schema)

DNS Forwarder Zone

Used to configure zones on DNS Forwarder

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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
dns_domain_names	List of domain names List of domain names on which conditional forwarding is based. This field is required if the DNS Zone is being used for a conditional forwarder. This field will also be used for conditional reverse lookup. Example 1, if for one of the zones, one of the entries in the fqdn is example.com, all the DNS requests under the domain example.com will be served by the corresponding upstream DNS server. Example 2, if for one of the zones, one of the entries in the fqdn list is "13.12.30.in-addr.arpa", reverse lookup for 30.12.13.0/24 will go to the corresponding DNS server.	array of string
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 PolicyDnsForwarderZone	string
source_ip	Source IP used by DNS Forwarder zone The source IP used by the DNS Forwarder zone.	IPv4Address
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly
upstream_servers	DNS servers to which the DNS request needs to be forwarded Max of 3 DNS servers can be configured	array of IPv4Address	Required Maximum items: 3

PolicyDnsForwarderZoneListRequestParameters (schema)

DNS Forwarder Zone 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
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

PolicyDnsForwarderZoneListResult (schema)

Paged Collection of DNS Forwarder 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	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Dns Forwarder Zone list results	array of PolicyDnsForwarderZone	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

PolicyEdgeCluster (schema)

Edge Cluster

Edge Cluster.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource (Abstract type: pass one of the following concrete types) ChildPolicyEdgeNode
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	Sortable
inter_site_forwarding_enabled	Inter site forwarding is enabled if true Flag to indicate status of inter site l2 and l3 forwarding in federation.	boolean	Readonly
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
nsx_id	Edge Cluster UUID on NSX-T Enforcement Point UUID of Edge Cluster on NSX-T enforcement point.	string	Readonly
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 PolicyEdgeCluster	string
rtep_ips	Remote tunnel endpoint IP addresses. List of remote tunnel endpoint ipaddress configured on edge cluster.	array of IPAddress	Readonly
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

PolicyEdgeClusterInterSiteBgpSummary (schema)

Name	Description	Type	Notes
edge_cluster_path	Edge node path Edge cluster path whose status is being reported.	string	Required Readonly
edge_nodes	Individual edge nodes status Status of all edge nodes within cluster.	array of PolicyEdgeNodeInterSiteBgpSummary	Readonly

PolicyEdgeClusterInterSiteStatus (schema)

Name	Description	Type	Notes
edge_cluster_name	Edge cluster name Name of the edge cluster whose status is being reported.	string	Readonly
edge_cluster_path	Edge cluster path Policy path of the edge cluster whose status is being reported.	string	Required Readonly
last_update_timestamp	Last updated timestamp Timestamp when the edge cluster inter-site status was last updated.	EpochMsTimestamp	Required Readonly
member_status	Per edge node inter-site status Per edge node inter-site status.	array of PolicyEdgeClusterMemberInterSiteStatus	Readonly
overall_status	Overall IBGP status in the edge cluster Overall status of all edge nodes IBGP status in the edge cluster.	string	Readonly Enum: UP, DOWN, DEGRADED, UNKNOWN

PolicyEdgeClusterListRequestParameters (schema)

Policy Edge Cluster List Request Parameters

Policy Edge Cluster 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
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

PolicyEdgeClusterListResult (schema)

Paged Collection of Edge Cluster

Paged Collection of Edge Cluster

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Edge Cluster List Result Edge Cluster list result.	array of PolicyEdgeCluster	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

PolicyEdgeClusterMemberInterSiteStatus (schema)

Name	Description	Type	Notes
edge_node_path	Edge node path Edge node details from where the status is being retrived.	ResourceReference	Required Readonly
established_bgp_sessions	Established inter-site IBGP sessions Total number of current established inter-site IBGP sessions.	integer	Readonly
neighbor_status	BGP neighbor status Inter-site BGP neighbor status.	array of PolicyBgpNeighborStatus	Readonly
status	Edge node IBGP status Edge node IBGP status	string	Readonly Enum: UP, DOWN, DEGRADED, UNKNOWN
total_bgp_sessions	Total inter-site IBGP sessions Total number of inter-site IBGP sessions.	integer	Readonly

PolicyEdgeNode (schema)

Policy Edge Node

This object serves as a representation of the edge cluster
index to which the edge node connects. It should not be
mistaken for the edge / transport node itself. Consuming services
can refer to the nsx_id property to fetch the UUID of the
edge / transport node that is attached to this index.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
member_index	Member Index The numerical value of the member index in the edge cluster that this object represents and to which the edge node connects.	integer	Readonly
nsx_id	Edge Node UUID on NSX-T Enforcement Point UUID of edge node on NSX-T enforcement point.	string	Readonly
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 PolicyEdgeNode	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

PolicyEdgeNodeInterSiteBgpSummary (schema)

Name	Description	Type	Notes
edge_node_path	Edge node path Edge node path whose status is being reported.	string	Required Readonly
last_update_timestamp	Last updated timestamp Timestamp when the inter-site IBGP neighbors status was last updated.	EpochMsTimestamp	Required Readonly
neighbor_status	Inter-site IBGP neighbors status Status of all inter-site IBGP neighbors.	array of PolicyBgpNeighborStatus	Readonly

PolicyEdgeNodeListRequestParameters (schema)

Edge Node List Request Parameters

Edge Node 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
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

PolicyEdgeNodeListResult (schema)

Paged Collection of Edge Node

Paged Collection of Edge Node

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Edge Node List Result Edge Node list result.	array of PolicyEdgeNode	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

PolicyExcludeList (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
members	ExcludeList member list List of the members in the exclude list	array of string	Required Maximum items: 100
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 PolicyExcludeList	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

PolicyFineTuningResourceInfo (schema)

Contains the detail of resources with name and fields

It represent the resource with details of name and fields it owns.

Name	Description	Type	Notes
fields	List of all field of any resource	array of PolicyFineTuningResourceInfoDetail	Required
resource_name	Resource name It will represent resource with name and fields.	string	Required

PolicyFineTuningResourceInfoDetail (schema)

Contains the details resources with field type and name

Contains the details of resource field

Name	Description	Type	Notes
field_name	Resource name It will represent resource with name and fields.	string	Required
sub_type	List of all field of any resource	PolicyFineTuningResourceInfo	Required

PolicyFirewallCPUMemThresholdsProfileBindingMap (schema)

Policy DFW CPU Memory Thresholds Profile binding map

This entity will be used to establish association between CPU Memory
Thresholds Profile and Transport Node. Using this entity, user can specify
intent for applying Firewall CPU Memory Thresholds Profile to particular
Transport Node.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
profile_path	Profile Path PolicyPath of associated Profile	string	Required
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value PolicyFirewallCPUMemThresholdsProfileBindingMap	string
sequence_number	Sequence number of this profile binding map Sequence number is used to resolve conflicts when two profiles get applied to a single node. Lower value gets higher precedence. Two binding maps having the same profile path should have the same sequence number.	integer	Required Minimum: 0 Maximum: 4294967295
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
transport_nodes	References of transport nodes References of transport nodes on which the profile intended to be applied.	array of PolicyResourceReference
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

PolicyFirewallCPUMemThresholdsProfileBindingMapListRequestParameters (schema)

Policy Firewall CPU Memory Thresholds Profile Binding Map 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
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

PolicyFirewallCPUMemThresholdsProfileBindingMapListResult (schema)

Paged collection of Firewall CPU Memory Thresholds Profile Binding Maps

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Firewall CPU Memory Thresholds Profile Binding Map list results	array of PolicyFirewallCPUMemThresholdsProfileBindingMap	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

PolicyFirewallCpuMemThresholdsProfile (schema)

Firewall CPU and memory thresholds profile

A profile holding CPU and memory thresholds configuration.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
cpu_threshold_percentage	CPU utilization thresholds percentage CPU utilization thresholds percentage to monitor and report for distributed firewall.	integer	Required Minimum: 10 Maximum: 100 Default: "90"
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
mem_threshold_percentage	Heap memory thresholds utilization percentage Heap memory thresholds percentage to monitor and report for distributed firewall.	integer	Required Minimum: 10 Maximum: 100 Default: "90"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 PolicyFirewallCpuMemThresholdsProfile	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

PolicyFirewallCpuMemThresholdsProfileListResult (schema)

Paged Collection of PolicyFirewallCpuMemThresholdsProfile

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	PolicyFirewallCpuMemThresholdsProfile list results	array of PolicyFirewallCpuMemThresholdsProfile	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

PolicyFirewallFloodProtectionProfileBindingMap (schema)

Policy DFW Flood Protection Profile binding map

This entity will be used to establish association between Firewall Flood
Protection profile and Group. Using this entity, user can specify intent
for applying Firewall Flood Protection profile to particular 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.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
profile_path	Profile Path PolicyPath of associated Profile	string	Required
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value PolicyFirewallFloodProtectionProfileBindingMap	string
sequence_number	Sequence number of this profile binding map. Sequence number is used to resolve conflicts when two profiles get applied to a single port. Lower value gets higher precedence. Two binding maps having the same profile path should have the same sequence number.	integer	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

PolicyFirewallFloodProtectionProfileBindingMapListRequestParameters (schema)

Policy Firewall Flood Protection Profile Binding Map 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
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

PolicyFirewallFloodProtectionProfileBindingMapListResult (schema)

Paged collection of Firewall Flood Protection Profile Binding Maps

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Firewall Flood Protection Profile Binding Map list results	array of PolicyFirewallFloodProtectionProfileBindingMap	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

PolicyFirewallScheduler (schema)

Policy Firewall Scheduler entity

An entity that encapsulates attributes to schedule firewall rules to
be active to allow or block traffic for a specific period of time.
Note that at least one property out of "days", "start_time",
"end_time", "start_date", "end_date" is required.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
days	Days of the week Days of week on which rules will be enforced. If property is omitted, then days of the week will not considered while calculating the firewall schedule. It should not be present when the recurring flag is false.	array of PolicyFirewallSchedulerDays
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
end_date	End date in MM/DD/YYYY End date on which schedule to end. Example, 12/22/2019.	string	Required
end_time	End time If recurring field is set false, then this field must be present. The schedule will be enforced till the end time of the specified end date. If recurring field is set true, then this field should not be present.	string
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
recurring	Firewall schedule recurring flag Flag to indicate whether firewall schedule recurs or not. The default value is true and it should be set to false when the firewall schedule does not recur and is a one time time interval.	boolean	Required Default: "True"
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value PolicyFirewallScheduler	string
start_date	Start date in MM/DD/YYYY Start date on which schedule to start. Example, 02/22/2019.	string	Required
start_time	Start time Time in 24 hour and minutes in multiple of 30. Example, 9:00. If recurring field is set false, then this field must be present. The schedule will start getting enforced from the start time of the specified start date. If recurring field is set true, then this field should not be present.	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
time_interval	Recurring time interval The recurring time interval in a day during which the schedule will be applicable. It should not be present when the recurring flag is false.	array of PolicyTimeIntervalValue	Maximum items: 1
timezone	Host timezone Host Timezone to be used to enforce firewall rules.	string	Required Enum: UTC, LOCAL
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

PolicyFirewallSchedulerDays (schema)

Day on which scheduled firewall rule will be enforced

Name	Description	Type	Notes
PolicyFirewallSchedulerDays	Day on which scheduled firewall rule will be enforced	string	Enum: SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY

PolicyFirewallSchedulerDeleteRequestParameters (schema)

Policy Firewall Scheduler 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"

PolicyFirewallSchedulerListRequestParameters (schema)

Policy Firewall Scheduler 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
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

PolicyFirewallSchedulerListResult (schema)

List result of PolicyFirewallSchedulers

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Paged collection of PolicyFirewallSchedulers	array of PolicyFirewallScheduler	Readonly
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

PolicyFirewallSessionTimerProfile (schema)

Policy Firewall Session timeout profile

A profile holding TCP, UDP and ICMP session timeout configuration.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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_error_reply	Timeout after ICMP error The timeout value for the connection after an ICMP error came back in response to an ICMP packet. The default value for Edges (i.e, Gateway, or Logical Router) may be different than Distributed Firewall hosts.	integer	Required Minimum: 10 Maximum: 4320000 Default: "10"
icmp_first_packet	First packet connection timeout The timeout value of connection in seconds after the first packet. This will be the initial timeout for the new ICMP flow. The default value for Edges (i.e, Gateway, or Logical Router) may be different than Distributed Firewall hosts.	integer	Required Minimum: 10 Maximum: 4320000 Default: "20"
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 PolicyFirewallSessionTimerProfile	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
tcp_closed	Timeout after RST The timeout value of connection in seconds after one endpoint sends an RST. The default value for Edges (i.e, Gateway, or Logical Router) may be different than Distributed Firewall hosts.	integer	Required Minimum: 10 Maximum: 4320000 Default: "20"
tcp_closing	Timeout after first TN The timeout value of connection in seconds after the first FIN has been sent. The default value for Edges (i.e, Gateway, or Logical Router) may be different than Distributed Firewall hosts.	integer	Required Minimum: 10 Maximum: 4320000 Default: "120"
tcp_established	Connection timeout The timeout value of connection in seconds once the connection has become fully established. The default value for Edges (i.e, Gateway,or Logical Router) may be different than Distributed Firewall hosts.	integer	Required Minimum: 120 Maximum: 4320000 Default: "43200"
tcp_finwait	Timeout after FINs exchanged The timeout value of connection in seconds after both FINs have been exchanged and connection is closed. The default value for Edges (i.e, Gateway, or Logical Router) may be different than Distributed Firewall hosts.	integer	Required Minimum: 10 Maximum: 4320000 Default: "45"
tcp_first_packet	Connection timout after first packet The timeout value of connection in seconds after the first packet has been sent. The default value for Edges (i.e, Gateway, or Logical Router) may be different than Distributed Firewall hosts.	integer	Required Minimum: 10 Maximum: 4320000 Default: "120"
tcp_opening	Connection timout after second packet The timeout value of connection in seconds after a second packet has been transferred. The default value for Edges (i.e, Gateway, or Logical Router) may be different than Distributed Firewall hosts.	integer	Required Minimum: 10 Maximum: 4320000 Default: "30"
udp_first_packet	Connection timout after first packet The timeout value of connection in seconds after the first packet. This will be the initial timeout for the new UDP flow. The default value for Edges (i.e, Gateway, or Logical Router) may be different than Distributed Firewall hosts.	integer	Required Minimum: 10 Maximum: 4320000 Default: "60"
udp_multiple	Timeout after hosts sent packet The timeout value of connection in seconds if both hosts have sent packets. The default value for Edges (i.e, Gateway, or Logical Router) may be different than Distributed Firewall hosts.	integer	Required Minimum: 10 Maximum: 4320000 Default: "60"
udp_single	Connection timeout for destination The timeout value of connection in seconds if the source host sends more than one packet but the destination host has never sent one back. The default value for Edges (i.e, Gateway, or Logical Router) may be different than Distributed Firewall hosts.	integer	Required Minimum: 10 Maximum: 4320000 Default: "30"
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

PolicyFirewallSessionTimerProfileBindingMap (schema)

Policy DFW Timer Session Profile binding map

This entity will be used to establish association between Firewall Timer session
profile and Group. Using this entity, user can specify intent for applying
Firewall Timer session profile to particular 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.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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
firewall_session_timer_profile_path	Firewall Session Timer Profile Path PolicyPath of associated Firewall Timer Session Profile	string	Required
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 PolicyFirewallSessionTimerProfileBindingMap	string
sequence_number	Sequence number of this profile binding map. Sequence number is used to resolve conflicts when two profiles get applied to a single port. Lower value gets higher precedence. Two binding maps having the same profile path should have the same sequence number.	integer
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

PolicyFirewallSessionTimerProfileBindingMapListRequestParameters (schema)

Policy Firewall Session Timer Profile Binding Map 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
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

PolicyFirewallSessionTimerProfileBindingMapListResult (schema)

Paged collection of Firewall Session Timer Profile Binding Maps

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Firewall Session Timer Profile Binding Map list results	array of PolicyFirewallSessionTimerProfileBindingMap	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

PolicyFirewallSessionTimerProfileListRequestParameters (schema)

Policy Firewall Session timeout profile 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
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

PolicyFirewallSessionTimerProfileListResult (schema)

Paged Collection of Policy Firewall Session timeout profiles

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Policy Firewall Session timeout profile list results	array of PolicyFirewallSessionTimerProfile	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

PolicyGroupIPMembersListResult (schema)

Group IP members list result

Paginated collection of IP members belonging to a Group.

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Paged Collection of IP addresses that belong to the given Group	array of IPElement	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

PolicyGroupMemberDetails (schema)

Group member details

Details of the member belonging to a Group

Name	Description	Type	Notes
display_name	The display name of the member on the enforcement point	string	Required Readonly
id	The ID of the member on the enforcement point	string	Required Readonly
path	The path of the member, if relevant	string	Required Readonly

PolicyGroupMembersListResult (schema)

Group members list result

Paginated collection of members belonging to a Group.

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Paged Collection of members that belong to the given Group	array of PolicyGroupMemberDetails	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

PolicyGroupServiceAssociationsRequestParameters (schema)

Associations 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
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
intent_path	Path of the entity Path of the entity for which associated services are to be fetched.	string	Required
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

PolicyIKEDigestAlgorithm (schema) (Deprecated)

Digest Algorithms used in IKE negotiations

The IKEDigestAlgorithms are used to verify message integrity during IKE negotiation.
SHA1 produces 160 bits hash and SHA2_256 produces 256 bit hash.

Name	Description	Type	Notes
PolicyIKEDigestAlgorithm	Digest Algorithms used in IKE negotiations The IKEDigestAlgorithms are used to verify message integrity during IKE negotiation. SHA1 produces 160 bits hash and SHA2_256 produces 256 bit hash.	string	Deprecated Enum: SHA1, SHA2_256

PolicyIKEEncryptionAlgorithm (schema) (Deprecated)

Encryption algorithms used in IKE

IKEEncryption algorithms are used to ensure confidentiality of the messages
exchanged during IKE negotiations. AES stands for Advanced Encryption Standards.
AES_128 uses 128-bit keys whereas AES_256 uses 256-bit keys for encryption and
decryption. AES_GCM stands for Advanced Encryption Standard(AES) in Galois/Counter
Mode(GCM) and is used to provide both confidentiality and data origin authentication.
AES_GCM composed of two separate functions one for encryption(AES) and one for
authentication(GMAC). AES_GCM algorithms will be available with IKE_V2 version only.
AES_GMAC_128 uses 128-bit keys.
AES_GMAC_192 uses 192-bit keys.
AES_GMAC_256 uses 256-bit keys.

Name	Description	Type	Notes
PolicyIKEEncryptionAlgorithm	Encryption algorithms used in IKE IKEEncryption algorithms are used to ensure confidentiality of the messages exchanged during IKE negotiations. AES stands for Advanced Encryption Standards. AES_128 uses 128-bit keys whereas AES_256 uses 256-bit keys for encryption and decryption. AES_GCM stands for Advanced Encryption Standard(AES) in Galois/Counter Mode(GCM) and is used to provide both confidentiality and data origin authentication. AES_GCM composed of two separate functions one for encryption(AES) and one for authentication(GMAC). AES_GCM algorithms will be available with IKE_V2 version only. AES_GMAC_128 uses 128-bit keys. AES_GMAC_192 uses 192-bit keys. AES_GMAC_256 uses 256-bit keys.	string	Deprecated Enum: AES_128, AES_256, AES_GCM_128, AES_GCM_192, AES_GCM_256

PolicyIKEVersion (schema) (Deprecated)

IKE version

IKE protocol version to be used. IKE-Flex will initiate IKE-V2 and responds
to both IKE-V1 and IKE-V2.

Name	Description	Type	Notes
PolicyIKEVersion	IKE version IKE protocol version to be used. IKE-Flex will initiate IKE-V2 and responds to both IKE-V1 and IKE-V2.	string	Deprecated Enum: IKE_V1, IKE_V2, IKE_FLEX

PolicyIPAddressInfo (schema) (Deprecated)

IP address information

Used to specify the display name and value of the IPv4Address.

Name	Description	Type	Notes
address_value	Value of the IPv4Address Value of the IPv4Address.	IPv4Address	Required
display_name	Display name of the IPv4Address Display name used to help identify the IPv4Address.	string
next_hop	Next Hop of the IPv4Address Next hop used in auto-plumbing of static route. If a value is not provided, static route will not be auto-plumbed.	IPv4Address

PolicyIgmpProfile (schema)

IGMP Profile

IGMP profile.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
last_member_query_interval	Max Response Time Max Response Time inserted into Group-Specific Queries sent in response to Leave Group messages, and is also the amount of time between Group-Specific Query messages. This value may be tuned to modify the "leave latency" of the network. A reduced value results in reduced time to detect the loss of the last member of a group.	int	Minimum: 1 Maximum: 25 Default: "1"
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
query_interval	Interval between general IGMP host-query messages Interval(seconds) between general IGMP host-query messages.	int	Minimum: 1 Maximum: 1800 Default: "30"
query_max_response_time	The maximum elapsed time between response The query response interval(seconds) is the maximum amount of time that can elapse between when the querier router sends a host-query message and when it receives a response from a host. Configuring this interval allows admins to adjust the burstiness of IGMP messages on the subnet; larger values make the traffic less bursty, as host responses are spread out over a larger interval. The number of seconds represented by the query_max_response_time must be less than the query_interval.	int	Minimum: 1 Maximum: 25 Default: "10"
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value PolicyIgmpProfile	string
robustness_variable	The Robustness Variable The Robustness Variable allows tuning for the expected packet loss on a subnet. If a subnet is expected to be lossy, the Robustness Variable may be increased. IGMP is robust to (Robustness Variable-1) packet losses. The Robustness Variable must not be zero, and SHOULD NOT be one.	int	Minimum: 1 Maximum: 255 Default: "2"
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

PolicyInsertParameters (schema)

Parameters to tell where security policy/rule needs to be placed

Parameters to let the admin specify a relative position of a security
policy or rule w.r.t to another one.

Name	Description	Type	Notes
anchor_path	The security policy/rule 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"

PolicyInterfaceOspfConfig (schema)

OSPF Interface configuration

OSPF Interface configuration.

Name	Description	Type	Notes
bfd_path	Policy path of BFD profile This filed is valid only if enable_bfd is set to TRUE. If enable_bfd flag is set to TRUE, this profile will be applied to all OSPF peers in this interface. If this field is empty, bfd_path will refer to Tier-0 global BFD profile.	string
dead_interval	OSPF dead interval in seconds Specifies the number of seconds that router must wait before it declares a OSPF neighbor router down because it has not received OSPF hello packet. OSPF dead interval should be minimum 3 times greater than the hello interval	int	Minimum: 3 Maximum: 65535 Default: "40"
enable_bfd	enable BFD for OSPF Enable/Disable OSPF to register for BFD event. Use FALSE to disable BFD.	boolean
enabled	enable/disable OSPF enable/disable OSPF on the interface. If enabled flag not specified, defailt is disable OSPF.	boolean	Default: "False"
hello_interval	OSPF hello interval in seconds Specifies the interval between the hello packets that OSPF sends on this interface. OSPF hello interval should be less than the dead interval	int	Minimum: 1 Maximum: 21845 Default: "10"
network_type	Configure OSPF networkt type Configure OSPF networkt type, default is BROADCAST network type	string	Enum: BROADCAST, P2P Default: "BROADCAST"
ospf_area	Attach Tier0 Interface to specified OSPF Area Attache Tier0 Interface to specified OSPF Area. all peers.	string	Required

PolicyInterfaceStatistics (schema)

Tier0 or Tier1 interface statistics on specific Enforcement Point

Tier0 or Tier1 interface statistics on specific Enforcement Point.

Name	Description	Type	Notes
logical_router_port_id	The ID of the logical router port	string	Required
per_node_statistics	Per Node Statistics	array of LogicalRouterPortStatisticsPerNode	Readonly

PolicyInterfaceStatisticsSummary (schema)

Tier0 or Tier1 interface statistics on specific Enforcement Point

Tier0 or Tier1 interface statistics on specific Enforcement Point.

Name	Description	Type	Notes
interface_policy_path	Policy path for the interface Policy path for the interface	string
last_update_timestamp	Timestamp when the data was last updated; unset if data source has never updated the data.	EpochMsTimestamp	Readonly
logical_router_port_id	The ID of the logical router port	string	Required
rx		LogicalRouterPortCounters	Readonly
tx		LogicalRouterPortCounters	Readonly

PolicyL2TablesParameters (schema)

Layer-2 table request parameters

Name	Description	Type	Notes
enforcement_point_path	String Path of the enforcement point Enforcement point path.	string
source	The data source, either realtime or cached. If not provided, cached data is returned.	DataSourceType
transport_node_id	TransportNode Id	string

PolicyLabel (schema)

Label to reference group of policy entities of same type.

Label to reference group of policy entities of same type.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
refs	Policy entity paths referred by the label instance Policy entity paths referred by the label instance	array of string
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value PolicyLabel	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
type	Policy intent entity type from PolicyResourceType Policy intent entity type from PolicyResourceType	string	Required
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

PolicyLabelListRequestParameters (schema)

PolicyLabel 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
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

PolicyLabelListResult (schema)

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	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Policy label list results	array of PolicyLabel	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

PolicyLbMonitorProfile (schema)

Base class for each type or protocol of PolicyLbMonitorProfile

All the types of PolicyLbMonitorProfile extend from this abstract class.
This is present for extensibility.
This is an abstract type. Concrete child types:
HttpPolicyLbMonitorProfile
HttpsPolicyLbMonitorProfile
IcmpPolicyLbMonitorProfile
TcpPolicyLbMonitorProfile
UdpPolicyLbMonitorProfile

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
fall_count	Monitor fall count for active healthchecks Only if a healthcheck fails consecutively for a specified number of times, given with fall_count, to a member will the member status be marked DOWN.	integer	Default: "3"
id	Unique identifier of this resource	string	Sortable
interval	Monitor interval in seconds for active healthchecks Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group.	integer	Default: "5"
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
monitor_port	Monitor port for active healthchecks Typically, monitors perform healthchecks to Group members using the member IP address and pool_port. However, in some cases, customers prefer to run healthchecks against a different port than the pool member port which handles actual application traffic. In such cases, the port to run healthchecks against can be specified in the monitor_port value.	int	Minimum: 0 Maximum: 65535
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 PolicyLbMonitorProfile	string	Required Enum: TcpPolicyLbMonitorProfile, UdpPolicyLbMonitorProfile, IcmpPolicyLbMonitorProfile, HttpPolicyLbMonitorProfile, HttpsPolicyLbMonitorProfile
rise_count	Monitor rise count for active healthchecks Once a member is DOWN, a specified number of consecutive successful healthchecks specified by rise_count will bring the member back to UP state.	integer	Default: "3"
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
timeout	Monitor timeout in seconds for active healthchecks Timeout specified in seconds. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.	integer	Default: "15"
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

PolicyLbPersistenceProfile (schema)

Contains the information related to load balancer persistence options

Some applications maintain state and require all relevant connections
to be sent to the same server as the application state is not
synchronized among servers. Persistence is enabled on a
PolicyLbVirtualServer by binding a persistence profile to it.
This is an abstract type. Concrete child types:
CustomPolicyLbPersistenceProfile
L4PolicyLbPersistenceProfile
L7PolicyLbPersistenceProfile

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 PolicyLbPersistenceProfile	string	Required Enum: L4PolicyLbPersistenceProfile, L7PolicyLbPersistenceProfile, CustomPolicyLbPersistenceProfile
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

PolicyLbPoolAccess (schema)

Defining access a Group from a PolicyLbVirtualServer and binding to PolicyLbMonitorProfile

Defining access of a Group from a PolicyLbVirtualServer and binding to
PolicyLbMonitorProfile.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
algorithm	Load balancing algorithm Load balanding algorithm controls how the incoming connections are distributed among the members. - ROUND_ROBIN - requests to the application servers are distributed in a round-robin fashion, - LEAST_CONNECTION - next request is assigned to the server with the least number of active connections	string	Enum: ROUND_ROBIN, LEAST_CONNECTION Default: "ROUND_ROBIN"
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
ip_port_list	IP Port list for applications within the Group IP Port list for applications within the Group to allow for non-uniform port usage by applications	array of IPAddressPortPair
lb_monitor_profile	Path of the PolicyLbMonitorProfile to actively monitor the PolicyLbPoolAccess's Group Path of the PolicyLbMonitorProfile to actively monitor the PolicyLbPoolAccess's Group	string
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
pool_port	Port for LoadBalancer to send traffic Port for LoadBalancer to send connections to the PolicyLbPoolAccess's Group. Pool_port could be optional, if it is not specified, LB will use PolicyLbVirtualServer port to connect to backend servers. If the PolicyLbMonitorProfile is configured in PolicyLbPoolAccess and active monitor IP protocol is TCP/UDP(which requires TCP or UDP port number), monitor_port should be specified if pool_port is unset.	int	Minimum: 0 Maximum: 65535
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value PolicyLbPoolAccess	string
source_nat	Source NAT setting of the PolicyLbPoolAccess Depending on the topology, Source NAT (SNAT) may be required to ensure traffic from the server destined to the client is received by the load balancer. SNAT can be enabled per pool. If SNAT is not enabled for a pool, then load balancer uses the client IP and port (spoofing) while establishing connections to the servers. This is referred to as no-SNAT or TRANSPARENT mode. SNAT is enabled by default and will use the load balancer interface IP and an ephemeral port as the source IP and port of the server side connection.	string	Enum: ENABLED, DISABLED Default: "ENABLED"
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

PolicyLbRule (schema)

Binding of a LbPoolAccess and Group to a PolicyLbVirtualServer

Binding of a LbPoolAccess and Group to a PolicyLbVirtualServer
used to route application traffic passing through load balancers.
PolicyLbRule uses match conditions to match application traffic passing
through a PolicyLbVirtualServer using HTTP or HTTPS. Can bind
multiple PolicyLbVirtualServers to a Group. Each PolicyLbRule
consists of two optional match conditions, each match contidion defines a
criterion for application traffic. If no match conditions are
specified, then the PolicyLbRule will always match and it is used
typically to define default rules. If more than one match condition is
specified, then matching strategy determines if all conditions should
match or any one condition should match for the PolicyLbRule to be
considered a match. A match indicates that the PolicyLbVirtualServer
should route the request to the Group (parent of PolicyLbRule).

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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_match	Host HTTP header match condition This condition is used to match HTTP request messages by the specific HTTP header field, Host. The Host request header specifies the domain name of the server. The supplied Host HTTP header match condition will be matched as a regular expression. The regular expressions in load balancer rules use the features common to both Java regular expressions and Perl Compatible Regular Expressions (PCREs) with some restrictions. Reference http://www.pcre .org for PCRE and the NSX-T Administrator's Guide for the restrictions. Please note, when regular expressions are used in JSON (JavaScript Object Notation) string, every backslash character (\) needs to be escaped by one additional backslash character.	string
id	Unique identifier of this resource	string	Sortable
lb_virtual_server	PolicyLbVirtualServer path The path of PolicyLbVirtualServer to bind to this PolicyLbRule and its Group	string
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
match_strategy	Match strategy for determining match of multiple conditions If more than one match condition is specified, then matching strategy determines if all conditions should match or any one condition should match for the LB Rule to be considered a match. - ALL indicates that both host_match and path_match must match for this PolicyLbRule to be considered a match - ANY indicates that either host_match or patch match may match for this PolicyLbRule to be considered a match	string	Enum: ALL, ANY Default: "ANY"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
path_match	HTTP request uri match condition This condition is used to match URIs(Uniform Resource Identifier) of HTTP request messages. The URI field can be specified as a regluar expression. If an HTTP request message is requesting an URI which matches specified regular expression, it matches the condition. The syntax of whole URI looks like this: scheme:[//[user[:password]@]host[:port]][/path][?query][#fragment] This condition matches only the path part of entire URI. The path_match field is used as a regular expression to match URI path of HTTP requests. For example, to match any URI that has "/image/" or "/images/", uri field can be specified as: "/image[s]?/". The regular expressions in load balancer rules use the features common to both Java regular expressions and Perl Compatible Regular Expressions (PCREs) with some restrictions. Reference http://www.pcre .org for PCRE and the NSX-T Administrator's Guide for the restrictions. Please note, when regular expressions are used in JSON (JavaScript Object Notation) string, every backslash character (\) needs to be escaped by one additional backslash character.	string
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value PolicyLbRule	string
sequence_number	Sequence number of the this PolicyLbRule This field is used to resolve conflicts between multiple PolicyLbRules associated with a single PolicyLbVirtualServer and will be applied numerically or low to high	int
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

PolicyLbVirtualServer (schema)

Base class for each type of PolicyLbVirtualServer

All the types of PolicyLbVirtualServer extend from this abstract class. This
is present for extensibility.
This is an abstract type. Concrete child types:
CustomPolicyLbVirtualServer
HttpPolicyLbVirtualServer
HttpsPolicyLbVirtualServer
TcpPolicyLbVirtualServer
UdpPolicyLbVirtualServer

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
access_log_enabled	Access log enabled setting If access log is enabled, all HTTP requests sent to an L7 virtual server are logged to the access log file. Both successful requests (backend server returns 2xx) and unsuccessful requests (backend server returns 4xx or 5xx) are logged to access log, if enabled.	boolean	Default: "False"
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
ip_address	IP address of the PolicyLbVirtualServer Configures the IP address of the PolicyLbVirtualServer where it receives all client connections and distributes them among the backend servers.	IPAddress	Required
lb_persistence_profile	Persistence Profile used by PolicyLbVirtualServer Path to optional object that enables persistence on a virtual server allowing related client connections to be sent to the same backend server. Persistence is disabled by default.	string
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
ports	Virtual server port number(s) or port range(s) Ports contains a list of at least one port or port range such as "80", "1234-1236". Each port element in the list should be a single port or a single port range.	array of PortElement	Required
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value PolicyLbVirtualServer	string	Required Enum: TcpPolicyLbVirtualServer, UdpPolicyLbVirtualServer, HttpPolicyLbVirtualServer, HttpsPolicyLbVirtualServer, CustomPolicyLbVirtualServer
router_path	Path to router type object for PolicyLbVirtualServer Path to router type object that PolicyLbVirtualServer connects to. The only supported router object is Network.	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
traffic_source		string
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

PolicyListL2TablesParameters (schema)

Layer-2 table 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
enforcement_point_path	String Path of the enforcement point Enforcement point path.	string
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string
source	The data source, either realtime or cached. If not provided, cached data is returned.	DataSourceType
transport_node_id	TransportNode Id	string

PolicyListRequestParameters (schema)

Policy 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
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

PolicyListResult (schema)

Paged Collection of security policies

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

PolicyLiveTraceActionConfig (schema)

Livetrace action configuration

Name	Description	Type	Notes
count_config	Configuration of count action	CountActionConfig
pktcap_config	Configuration of packet capture action	LiveTracePacketGranularActionConfig
trace_config	Configuration of trace action	LiveTracePacketGranularActionConfig

PolicyMulticastConfig (schema)

Multicast routing configuration

Multicast routing configuration.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
enabled	Enable/disable Multicast Configuration Enable/disable Multicast Configuration.	boolean	Default: "False"
id	Unique identifier of this resource	string	Sortable
igmp_profile_path	Policy path to IGMP profile Updates to IGMP profile applied on all Tier0 gateways consuming the configuration.	string
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
pim_profile_path	Policy path to PIM profile Updates to PIM profile applied on all Tier0 gateways consuming the configuration.	string
relative_path	Relative path of this object Path relative from its parent	string	Readonly
replication_multicast_range	Replication multicast range Replication multicast range. Required when enabled.	string
resource_type	Must be set to the value PolicyMulticastConfig	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

PolicyNATRuleCounters (schema)

Statistics count

Gives the statistics count of a NAT rule.

Name	Description	Type	Notes
active_sessions	Active sessions Gives the total number of active sessions.	integer	Readonly
total_bytes	Total bytes Gives the total number of bytes.	integer	Readonly
total_packets	Total packets Gives the total number of packets.	integer	Readonly

PolicyNat (schema)

Contains list of NAT Rules

Represents NAT section. This object is created by default when corresponding
tier-0/tier-1 is created. Under tier-0/tier-1 there will be 4 different NATs(sections).
(INTERNAL, USER, DEFAULT and NAT64).

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
nat_type	NAT section under tier-0/tier-1 Represents a NAT section under tier-0/tier-1.	string	Enum: INTERNAL, USER, DEFAULT, NAT64
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 PolicyNat	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

PolicyNatRule (schema)

Represents a NAT rule between source and destination at T0/T1 router

Represents a NAT rule between source and destination at T0/T1 router.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
action	Represents action of NAT Rule SNAT, DNAT, REFLEXIVE Source NAT(SNAT) - translates a source IP address in an outbound packet so that the packet appears to originate from a different network. SNAT is only supported when the logical router is running in active-standby mode. Destination NAT(DNAT) - translates the destination IP address of inbound packets so that packets are delivered to a target address into another network. DNAT is only supported when the logical router is running in active-standby mode. Reflexive NAT(REFLEXIVE) - IP-Range and CIDR are supported to define the "n". The number of original networks should be exactly the same as that of translated networks. The address translation is deterministic. Reflexive is supported on both Active/Standby and Active/Active LR. NO_SNAT and NO_DNAT - These do not have support for translated_fields, only source_network and destination_network fields are supported. NAT64 - translates an external IPv6 address to a internal IPv4 address.	string	Required Enum: SNAT, DNAT, REFLEXIVE, NO_SNAT, NO_DNAT, NAT64
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
description	Description of this resource	string	Maximum length: 1024 Sortable
destination_network	Represents the destination network This supports single IP address or comma separated list of single IP addresses or CIDR. This does not support IP range or IP sets. For DNAT and NO_DNAT rules, this is a mandatory field, and represents the destination network for the incoming packets. For other type of rules, optionally it can contain destination network of outgoing packets. NULL value for this field represents ANY network.	IPElementList
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
enabled	Policy NAT Rule enabled flag The flag, which suggests whether the NAT rule is enabled or disabled. The default is True.	boolean	Default: "True"
firewall_match	Represents the firewall match flag It indicates how the firewall matches the address after NATing if firewall stage is not skipped. MATCH_EXTERNAL_ADDRESS indicates the firewall will be applied to external address of a NAT rule. For SNAT, the external address is the translated source address after NAT is done. For DNAT, the external address is the original destination address before NAT is done. For REFLEXIVE, to egress traffic, the firewall will be applied to the translated source address after NAT is done; To ingress traffic, the firewall will be applied to the original destination address before NAT is done. MATCH_INTERNAL_ADDRESS indicates the firewall will be applied to internal address of a NAT rule. For SNAT, the internal address is the original source address before NAT is done. For DNAT, the internal address is the translated destination address after NAT is done. For REFLEXIVE, to egress traffic, the firewall will be applied to the original source address before NAT is done; To ingress traffic, the firewall will be applied to the translated destination address after NAT is done. BYPASS indicates the firewall stage will be skipped. For NO_SNAT or NO_DNAT, it must be BYPASS or leave it unassigned	string	Enum: MATCH_EXTERNAL_ADDRESS, MATCH_INTERNAL_ADDRESS, BYPASS Default: "MATCH_INTERNAL_ADDRESS"
id	Unique identifier of this resource	string	Sortable
logging	Policy NAT Rule logging flag The flag, which suggests whether the logging of NAT rule is enabled or disabled. The default is False.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 PolicyNatRule	string
scope	Array of policy paths of labels, ProviderInterface, NetworkInterface Represents the array of policy paths of ProviderInterface or NetworkInterface or labels of type ProviderInterface or NetworkInterface on which the NAT rule should get enforced. The interfaces must belong to the same router for which the NAT Rule is created.	array of string
sequence_number	Sequence number of the Nat Rule The sequence_number decides the rule_priority of a NAT rule. Sequence_number and rule_priority have 1:1 mapping.For each NAT section, there will be reserved rule_priority numbers.The valid range of rule_priority number is from 0 to 2147483647(MAX_INT). 1. INTERNAL section rule_priority reserved from 0 - 1023 (1024 rules) valid sequence_number range 0 - 1023 2. USER section rule_priority reserved from 1024 - 2147482623 (2147481600 rules) valid sequence_number range 0 - 2147481599 3. DEFAULT section rule_priority reserved from 2147482624 - 2147483647 (1024 rules) valid sequence_number range 0 - 1023	int	Default: "0"
service	Represents the service on which the NAT rule will be applied It represents the path of Service on which the NAT rule will be applied. If not provided or if it is blank then Policy manager will consider it as ANY. Please note, if this is a DNAT, the destination_port of the service will be realized on NSX Manager as the translated_port. And if this is a SNAT, the destination_port will be ignored.	string
source_network	Represents the source network address This supports single IP address or comma separated list of single IP addresses or CIDR. This does not support IP range or IP sets. For SNAT, NO_SNAT, NAT64 and REFLEXIVE rules, this is a mandatory field and represents the source network of the packets leaving the network. For DNAT and NO_DNAT rules, optionally it can contain source network of incoming packets. NULL value for this field represents ANY network.	IPElementList
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
translated_network	Represents the translated network address This supports single IP address or comma separated list of single IP addresses or CIDR. This does not support IP range or IP sets. For SNAT, DNAT, NAT64 and REFLEXIVE rules, this ia a mandatory field, which represents the translated network address. For NO_SNAT and NO_DNAT this should be empty.	IPElementList
translated_ports	Port number or port range Please note, if there is service configured in this NAT rule, the translated_port will be realized on NSX Manager as the destination_port. If there is no sevice configured, the port will be ignored.	PortElement
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

PolicyNatRuleListRequestParameters (schema)

NAT Rule 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
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

PolicyNatRuleListResult (schema)

Paged Collection of NAT Rules

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	NAT Rules list results	array of PolicyNatRule	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

PolicyNatRuleStatistics (schema)

Statistics of NAT Rule

Gives the Statistics of a NAT rule.

Name	Description	Type	Notes
active_sessions	Active sessions Gives the total number of active sessions.	integer	Readonly
last_update_timestamp	Last update timestamp Timestamp when the data was last updated.	EpochMsTimestamp	Readonly
total_bytes	Total bytes Gives the total number of bytes.	integer	Readonly
total_packets	Total packets Gives the total number of packets.	integer	Readonly
warning_message	Warning Message The warning message about the NAT Rule Statistics.	string	Readonly

PolicyNatRuleStatisticsListRequestParameters (schema)

NAT Rule statistics list request parameters

Request parameter to get NAT rule statistics.

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
enforcement_point_path	String Path of the enforcement point Enforcement point path, forward slashes must be escaped using %2F.	string
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

PolicyNatRuleStatisticsListResult (schema)

Collection of NAT Rule statistics

Gives the collection of NAT rule statistics per enforcement point.

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	NAT rules statistics per enforcement point	array of PolicyNatRuleStatisticsPerEnforcementPoint	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

PolicyNatRuleStatisticsPerEnforcementPoint (schema)

Statistics of NAT Rule per enforcement point

Gives the statistics of a NAT rule per enforcement point.

Name	Description	Type	Notes
enforcement_point_path	Enforcement point Path Policy Path referencing the enforcement point from where the statistics are fetched.	string
rule_path	Path of NAT Rule Path of NAT Rule.	string
rule_statistics	Rule statistics per enforcement point Gives NAT rule stats on an enforcement point.	array of PolicyNatRuleStatistics	Readonly

PolicyNatRuleStatisticsPerLogicalRouter (schema)

Statistics of NAT Rule per logical router

Gives the statistics of a NAT rule per logical router on specified enforcement point.

Name	Description	Type	Notes
enforcement_point_path	Enforcement point Path Policy Path referencing the enforcement point from where the statistics are fetched.	string
last_update_timestamp	Last update timestamp Timestamp when the data was last updated.	EpochMsTimestamp	Readonly
per_node_statistics	Detailed Rule statistics Detailed Rule statistics per logical router.	array of PolicyNatRuleStatisticsPerTransportNode	Readonly
router_path	Router path Path of the router.	string
statistics	Rolled up statistics Rolled up statistics for all rules on the logical router.	PolicyNATRuleCounters	Readonly

PolicyNatRuleStatisticsPerLogicalRouterListResult (schema)

Collection of NAT rule statistics per logical router

Gives the collection of NAT rule statistics per logical router on
specified enforcement point.

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	NAT rules statistics per logical router	array of PolicyNatRuleStatisticsPerLogicalRouter	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

PolicyNatRuleStatisticsPerTransportNode (schema)

Statistics of NAT Rule

Gives the Statistics of a NAT rule.

Name	Description	Type	Notes
active_sessions	Active sessions Gives the total number of active sessions.	integer	Readonly
last_update_timestamp	Last update timestamp Timestamp when the data was last updated.	EpochMsTimestamp	Readonly
total_bytes	Total bytes Gives the total number of bytes.	integer	Readonly
total_packets	Total packets Gives the total number of packets.	integer	Readonly
transport_node_path	Node path Policy path of the Edge Node.	string	Readonly

PolicyNonCompliantConfig (schema)

Name	Description	Type	Notes
affected_resources	Resources/Services impacted by non compliant configuration Resources/Services impacted by non compliant configuration	array of PolicyResourceReference	Readonly
description	Detail description of non compliant configuration with suggestive action	string	Readonly
non_compliance_code	Code for non compliant configuration	integer	Readonly
reported_by	Id and name of non compliant resource/service	PolicyResourceReference	Readonly

PolicyNsLookupParameters (schema)

Name	Description	Type	Notes
address	IP address or FQDN for nslookup	string
enforcement_point_path	String Path of the enforcement point enforcement point path, forward slashes must be escaped using %2F.	string

PolicyPimProfile (schema)

PIM profile

PIM profile.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
bsm_enabled	Enable/disable bootstrap messaging Configuration Enable/disable bootstrap messaging Configuration.	boolean	Default: "True"
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 PolicyPimProfile	string
rp_address	Static IPv4 multicast address configuration Static IPv4 multicast address configuration.	IPAddress
rp_address_multicast_ranges	Static IPv4 multicast address and assciated multicast groups configuration Static IPv4 multicast address and assciated multicast groups configuration.	array of RpAddressMulticastRanges
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

PolicyRealizedResource (schema)

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.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	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	Sortable
intent_reference	Desire state paths of this object	array of string
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
realization_api	Realization API of this object on enforcement point	string
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
runtime_error	String representation of runtime error It define the root cause for runtime error.	string
runtime_status	String representation of runtime status Possible values could be UP, DOWN, UNKNOWN, DEGRADED This list is not exhaustive.	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: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

PolicyRelatedApiError (schema)

Detailed information about errors from API call to an enforcement point

Name	Description	Type	Notes
details	Further details about the error	string
error_code	A numeric error code	integer
error_data	Additional data about the error	object
error_message	A description of the error	string
module_name	The module name where the error occurred	string

PolicyResource (schema)

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.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
parent_path	Path of its parent Path of its parent	string	Readonly
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: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

PolicyResourceReference (schema)

Policy resource reference

Policy resource reference.

Name	Description	Type	Notes
is_valid	Target validity Will be set to false if the referenced NSX resource has been deleted.	boolean	Readonly
path	Absolute path of this object Absolute path of this object.	string	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

PolicyResourceReferenceForEP (schema)

Policy resource reference for enforcement point

Policy resource reference for enforcement point

Name	Description	Type	Notes
is_valid	Target validity Will be set to false if the referenced NSX resource has been deleted.	boolean	Readonly
path	Absolute path of this object Absolute path of this object.	string	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

PolicyResourceReferenceForEPListResult (schema)

Policy resource reference list for enforcement point

Paginated collection of policy resource references for enforcement point

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Paged Collection of policy resource references for enforcement point	array of PolicyResourceReferenceForEP	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

PolicyResourceReferenceListResult (schema)

Paged Collection of PolicyResourceReference

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Policy resource references list results	array of PolicyResourceReference	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

PolicyRuntimeAlarm (schema)

Alarm of PolicyRuntimeInfoPerEP

Alarm associated with the PolicyRuntimeInfoPerEP that exposes
potential errors when retrieving runtime information from the
enforcement point.

Name	Description	Type	Notes
error_details	Error Detailed Information Detailed information about errors from an API call made to the enforcement point, if any.	PolicyApiError	Readonly
error_id	Alarm Error Id Alarm error id.	string	Readonly
message	Error Message to Describe the Issue Error message describing the issue.	string	Readonly

PolicyRuntimeInfoPerEP (schema)

PolicyRuntimeInfoPerEP

Runtime Info Per Enforcement Point.

Name	Description	Type	Notes
alarm	Alarm Information Details Alarm information details.	PolicyRuntimeAlarm	Readonly
enforcement_point_path	Enforcement point Path Policy Path referencing the enforcement point where the info is fetched.	string	Readonly

PolicyRuntimeOnEpRequestParameters (schema)

Request Parameters for Policy Runtime on enforcement point

Request parameters that represents an enforcement point path.
A request on runtime information can be parameterized with this path and will be
evaluated as follows:
- no enforcement point path specified: the request is evaluated on all enforcement
points.
- an enforcement point path is specified: the request is evaluated only on the given
enforcement point.

Name	Description	Type	Notes
enforcement_point_path	String Path of the enforcement point enforcement point path, forward slashes must be escaped using %2F.	string

PolicyRuntimeRequestParameters (schema)

Request Parameters for Policy Runtime Information

Request parameters that represents an enforcement point path and data source.
A request on runtime information can be parameterized with this pair and will be
evaluted as follows:
- no enforcement point path specified: the request is evaluated on all enforcement
points.
- an enforcement point path is specified: the request is evaluated only on the given
enforcement point.

Name	Description	Type	Notes
enforcement_point_path	String Path of the enforcement point enforcement point path, forward slashes must be escaped using %2F.	string
source	The data source, either realtime or cached. If not provided, cached data is returned.	DataSourceType

PolicySIExcludeList (schema)

Service Insertion Exclusion List

List of entities where Service Insertion will not be enforced. Exclusion List can contain PolicyGroup(s) or SegmentPort(s) or Segment(s).

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
members	ExcludeList member list List of the members in the exclude list	array of string	Required Maximum items: 100
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 PolicySIExcludeList	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

PolicySIStatusConfiguration (schema)

Service Insertion Status

It represents status of Service Insertion for North-South and East-West context types.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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
east_west_enabled	East-West status flag If set to true, service insertion for east-west traffic is enabled.	boolean	Default: "False"
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
north_south_enabled	North-South status flag If set to true, service insertion for north-south traffic is enabled.	boolean	Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 PolicySIStatusConfiguration	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

PolicyServiceChain (schema)

Policy Service Chain

Service chain is a set of network Services. A Service chain is made up of ordered list of service profiles belonging to any same or different services.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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
failure_policy	Failure Policy Failure policy for the service defines the action to be taken i.e to allow or to block the traffic during failure scenarios.	string	Enum: ALLOW, BLOCK Default: "ALLOW"
forward_path_service_profiles	Forward path service profiles Forward path service profiles are applied to ingress traffic.	array of string	Required Maximum items: 4
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
path_selection_policy	Path Selection Policy Path selection policy can be - ANY - Service Insertion is free to redirect to any service path regardless of any load balancing considerations or flow pinning. LOCAL - Preference to be given to local service insances. REMOTE - Preference to be given to the SVM co-located on the same host. ROUND_ROBIN - All active service paths are hit with equal probability.	string	Enum: ANY, LOCAL, REMOTE, ROUND_ROBIN Default: "ANY"
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value PolicyServiceChain	string
reverse_path_service_profiles	Reverse path service profiles Reverse path service profiles are applied to egress traffic and is optional. 2 different set of profiles can be defined for forward and reverse path. If not defined, the reverse of the forward path service profile is applied.	array of string	Maximum items: 4
service_segment_path	Path to service segment Path to service segment using which the traffic needs to be redirected.	array of string	Required Minimum items: 1 Maximum items: 1
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

PolicyServiceInstance (schema)

Represents an instance of partner Service and its configuration

Represents an instance of partner Service and its configuration.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
attributes	Deployment Template attributes List of attributes specific to a partner for which the service is created. There attributes are passed on to the partner appliance.	array of Attribute	Required Maximum items: 128
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
compute_id	Id of the compute resource. Id of the compute(ResourcePool) to which this service needs to be deployed.	string	Required
context_id	Id of the compute manager UUID of VCenter/Compute Manager as seen on NSX Manager, to which this service needs to be deployed.	string
deployment_mode	Deployment Mode Deployment mode specifies how the partner appliance will be deployed i.e. in HA or standalone mode.	string	Enum: STAND_ALONE, ACTIVE_STANDBY Default: "ACTIVE_STANDBY"
deployment_spec_name	Name of the Deployment Specification Form factor for the deployment of partner service.	string	Required
deployment_template_name	Name of the Deployment Template Template for the deployment of partnet service.	string	Required
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
failure_policy	Failure policy for the Service VM Failure policy for the Service VM. If this values is not provided, it will be defaulted to FAIL_CLOSE.	string	Enum: ALLOW, BLOCK Default: "BLOCK"
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
partner_service_name	Name of Partner Service Unique name of Partner Service in the Marketplace	string	Required
path	Absolute path of this object Absolute path of this object	string	Readonly
primary_gateway_address	Gateway for primary management console Gateway address for primary management console. If the provided segment already has gateway, this field can be omitted. But if it is provided, it takes precedence always. However, if provided segment does not have gateway, this field must be provided.	IPElement
primary_interface_mgmt_ip	Management IP Address of primary interface of the Service Management IP Address of primary interface of the Service	IPElement	Required
primary_interface_network	Path of the segment to which primary interface of the Service VM needs to be connected Path of the segment to which primary interface of the Service VM needs to be connected	string
primary_portgroup_id	Id of the standard or ditsributed port group for primary management console Id of the standard or ditsributed port group for primary management console. Please note that only 1 of the 2 values from 1. primary_interface_network 2. primary_portgroup_id are allowed to be passed. Both can't be passed in the same request.	string
primary_subnet_mask	Subnet for primary management console IP Subnet for primary management console IP. If the provided segment already has subnet, this field can be omitted. But if it is provided, it takes precedence always. However, if provided segment does not have subnet, this field must be provided.	IPElement
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value PolicyServiceInstance	string
secondary_gateway_address	Gateway for secondary management console Gateway address for secondary management console. If the provided segment already has gateway, this field can be omitted. But if it is provided, it takes precedence always. However, if provided segment does not have gateway, this field must be provided.	IPElement
secondary_interface_mgmt_ip	Management IP Address of secondary interface of the Service Management IP Address of secondary interface of the Service	IPElement
secondary_interface_network	Path of segment to which secondary interface of the Service VM needs to be connected Path of segment to which secondary interface of the Service VM needs to be connected	string
secondary_portgroup_id	Id of the standard or ditsributed port group for secondary management console Id of the standard or ditsributed port group for secondary management console. Please note that only 1 of the 2 values from 1. secondary_interface_network 2. secondary_portgroup_id are allowed to be passed. Both can't be passed in the same request.	string
secondary_subnet_mask	Subnet for secondary management console IP Subnet for secondary management console IP. If the provided segment already has subnet, this field can be omitted. But if it is provided, it takes precedence always. However, if provided segment does not have subnet, this field must be provided.	IPElement
storage_id	Id of the storage Id of the storage(Datastore). VC moref of Datastore to which this service needs to be deployed.	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
transport_type	Transport Type Transport to be used while deploying Service-VM.	string	Enum: L2_BRIDGE, L3_ROUTED Default: "L2_BRIDGE"
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

PolicyServiceProfile (schema)

Policy Service Profile for a given Service

Service profile represents specialization of a vendor template. User may provide any of the vendor_template_name or vendor_template_key properties. But in case of multiple vendor templates with the same name, it is recommended to use the vendor_template_key. When both attributes are provided, name is ignored and only key is used to identify the template. If there are multiple templates with same name, and vendor_template_name is provided, realization will fail.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
attributes	Service profile attributes List of attributes specific to a partner for which the service is created. These attributes are passed on to the partner appliance and are opaque to NSX. If a vendor template exposes configurable parameters, then their values are specified here.	array of Attribute	Maximum items: 128
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
redirection_action	Redirection action The redirection action represents if the packet is exclusively redirected to the service, or if a copy is forwarded to the service. Redirection action is not applicable to guest introspection service.	string	Enum: PUNT, COPY
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value PolicyServiceProfile	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly
vendor_template_key	Vendor Template Key The vendor template key property of actual vendor template. This should be used when multiple templates with same name exist.	string
vendor_template_name	Vendor template name Name of the vendor template for which this Service Profile is being created.	string

PolicySubAttributes (schema)

Policy Sub Attributes data holder

Name	Description	Type	Notes
datatype	Datatype for sub attribute	string	Required Enum: STRING
key	Key for sub attribute	string	Required Enum: TLS_CIPHER_SUITE, TLS_VERSION, CIFS_SMB_VERSION
value	Value for sub attribute key Multiple sub attribute values can be specified as elements of array.	array of string	Required Minimum items: 1

PolicyTask (schema)

Task information

This object holds the information of the task.

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
async_response_available	True if response for asynchronous request is available	boolean	Readonly
cancelable	True if this task can be canceled	boolean	Readonly
description	Description of the task	string	Readonly
end_time	The end time of the task in epoch milliseconds	EpochMsTimestamp	Readonly
failure_msg	Reason of the task failure This property holds the reason of the task failure, if any.	string	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

PolicyTepCsvListResult (schema)

Name	Description	Type	Notes
file_name	File name File name set by HTTP server if API returns CSV result as a file.	string
last_update_timestamp	Timestamp when the data was last updated; unset if data source has never updated the data.	EpochMsTimestamp	Readonly
results		array of PolicyTepTableCsvRecord

PolicyTepListResult (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
last_update_timestamp	Timestamp when the data was last updated; unset if data source has never updated the data.	EpochMsTimestamp	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results		array of PolicyTepTableEntry
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly
transport_node_id	Transport node identifier	string	Readonly

PolicyTepTableCsvRecord (schema)

Name	Description	Type	Notes
segment_id	TEP segment identifier This is the identifier of the TEP segment. This segment is NOT the same as logical segment or logical switch.	string
tep_ip	The tunnel endpoint IP address	IPAddress
tep_label	The tunnel endpoint label	integer	Required
tep_mac_address	The tunnel endpoint MAC address	string	Required

PolicyTepTableEntry (schema)

Name	Description	Type	Notes
segment_id	The segment Id	string
tep_ip	The tunnel endpoint IP address	IPAddress
tep_label	The tunnel endpoint label	integer
tep_mac_address	The tunnel endpoint MAC address	string

PolicyTier1MulticastConfig (schema)

Multicast routing configuration

Multicast routing configuration.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
enabled	Enable/disable Multicast Configuration Enable/disable Multicast Configuration. Whenever service router needs to be added/deleted from tier1, user needs to disable multicast first.	boolean	Default: "False"
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 PolicyTier1MulticastConfig	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

PolicyTimeIntervalValue (schema)

Time interval on which firewall schedule will be applicable

Name	Description	Type	Notes
end_interval	End time of the interval Time in 24 hour and minutes in multiple of 30. Example, 17:30.	string	Required
start_interval	Start time of the interval Time in 24 hour and minutes in multiple of 30. Example, 9:00.	string	Required

PolicyTransportZone (schema)

Transport Zone

Transport Zone.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
is_default	Flag to indicate if the transport zone is the default one Flag to indicate if the transport zone is the default one. Only one transport zone can be the default one for a given transport zone type.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
nsx_id	Transport Zone UUID on NSX-T Enforcement Point UUID of transport zone on NSX-T enforcement point.	string	Readonly
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 PolicyTransportZone	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
tz_type	Transport Zone Type Transport Zone Type.	string	Readonly Enum: OVERLAY_STANDARD, OVERLAY_ENS, VLAN_BACKED, UNKNOWN
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly
uplink_teaming_policy_names	Names of the switching uplink teaming policies that are supported by this transport zone. The names of switching uplink teaming policies that all transport nodes in this transport zone support. Uplinkin teaming policies are only valid for VLAN backed transport zones.	array of string

PolicyTransportZoneListRequestParameters (schema)

Policy Transport Zone List Request Parameters

Policy Transport Zone 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
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

PolicyTransportZoneListResult (schema)

Paged Collection of Transport Zone

Paged Collection of Transport Zone

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Transport Zone List Result Transport Zone list result.	array of PolicyTransportZone	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

PolicyTunnelDigestAlgorithm (schema) (Deprecated)

Digest Algorithms used in tunnel establishment

The TunnelDigestAlgorithms are used to verify message integrity during tunnel establishment.
SHA1 produces 160 bits hash and SHA2_256 produces 256 bit hash.

Name	Description	Type	Notes
PolicyTunnelDigestAlgorithm	Digest Algorithms used in tunnel establishment The TunnelDigestAlgorithms are used to verify message integrity during tunnel establishment. SHA1 produces 160 bits hash and SHA2_256 produces 256 bit hash.	string	Deprecated Enum: SHA1, SHA2_256

PolicyTunnelEncryptionAlgorithm (schema) (Deprecated)

Encryption algorithm used in tunnel

TunnelEncryption algorithms are used to ensure confidentiality of the messages exchanged
during Tunnel negotiations. AES stands for Advanced Encryption Standards. AES_128 uses
128-bit keys whereas AES_256 uses 256-bit keys for encryption and decryption. AES_GCM
stands for Advanced Encryption Standard(AES) in Galois/Counter Mode (GCM) and is used to
provide both confidentiality and data origin authentication.

Name	Description	Type	Notes
PolicyTunnelEncryptionAlgorithm	Encryption algorithm used in tunnel TunnelEncryption algorithms are used to ensure confidentiality of the messages exchanged during Tunnel negotiations. AES stands for Advanced Encryption Standards. AES_128 uses 128-bit keys whereas AES_256 uses 256-bit keys for encryption and decryption. AES_GCM stands for Advanced Encryption Standard(AES) in Galois/Counter Mode (GCM) and is used to provide both confidentiality and data origin authentication.	string	Deprecated Enum: AES_128, AES_256, AES_GCM_128, AES_GCM_192, AES_GCM_256

PolicyUrlCategorizationConfig (schema)

URL categorization entity

The type contains information about the configuration of the feature for a
specific node. It contains information like the whether the feature is
enabled/disabled, the context profiles defining the category list to
detect.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
context_profiles	Context profiles The ids of the context profiles that provides the list of categories to be detected. This field is deprecated. URL Categorization will not be supported in association with context profiles.	array of string	Deprecated
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
enabled	Enabled Property which specifies the enabling/disabling of the feature.	boolean	Required
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 PolicyUrlCategorizationConfig	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly
update_frequency	Policy URL Categorization Update Frequency The frequency in minutes at which the updates are downloaded from the URL categorization cloud service. The minimum allowed value is 5 minutes.	int	Minimum: 5 Default: "30"

PoolMemberAdminStateType (schema)

pool member admin state

User can set the admin state of a member to ENABLED or DISABLED or
GRACEFUL_DISABLED. By default, when a member is added, it is ENABLED.
If a member is set to DISABLED, it is not selected for any new
connections. Active connections, however, will continue to be processed
by it. New connections with matching persistence entries pointing to
DISABLED members are not sent to those DISABLED members. Those connections
are assigned to other members of the pool and the corresponding persistence
entries are updated to point to the newly selected server.
To allow for a more graceful way of taking down servers for maintenance, a
routine task, another admin state GRACEFUL_DISABLED is supported. Existing
connections to a member in GRACEFUL_DISABLED state continue to be processed.

Name	Description	Type	Notes
PoolMemberAdminStateType	pool member admin state User can set the admin state of a member to ENABLED or DISABLED or GRACEFUL_DISABLED. By default, when a member is added, it is ENABLED. If a member is set to DISABLED, it is not selected for any new connections. Active connections, however, will continue to be processed by it. New connections with matching persistence entries pointing to DISABLED members are not sent to those DISABLED members. Those connections are assigned to other members of the pool and the corresponding persistence entries are updated to point to the newly selected server. To allow for a more graceful way of taking down servers for maintenance, a routine task, another admin state GRACEFUL_DISABLED is supported. Existing connections to a member in GRACEFUL_DISABLED state continue to be processed.	string	Enum: ENABLED, DISABLED, GRACEFUL_DISABLED

PoolMemberSetting (schema)

Pool member setting

The setting is used to add, update or remove pool members from pool.
For static pool members, admin_state, display_name and weight can be
updated.
For dynamic pool members, only admin_state can be updated.

Name	Description	Type	Notes
admin_state	Member admin state	PoolMemberAdminStateType	Default: "ENABLED"
display_name	Pool member display name Only applicable to static pool members. If supplied for a pool defined by a grouping object, update API would fail.	string
ip_address	Pool member IP address	IPAddress	Required
port	Pool member port number	PortElement
weight	Pool member weight Only applicable to static pool members. If supplied for a pool defined by a grouping object, update API would fail.	integer	Minimum: 1 Maximum: 255

PortAddressBindingEntry (schema)

Address binding information

Detailed information about static address for the port.

Name	Description	Type	Notes
ip_address	IP address IP Address for port binding	string
mac_address	MAC address Mac address for port binding	MACAddress
vlan_id	VLAN ID VLAN ID for port binding	VlanID

PortAttacher (schema)

VM or vmknic entity attached to LogicalPort

Name	Description	Type	Notes
entity	Reference to the attached entity This is a vmknic name if the attacher is vmknic. Otherwise, it is full path of the attached VM's config file	string	Required
host	TransportNode on which the attacher resides	string	Required

PortAttachment (schema)

Attachment information on the port

Detail information about port attachment

Name	Description	Type	Notes
allocate_addresses	Allocate addresses Indicate how IP will be allocated for the port	string	Enum: IP_POOL, MAC_POOL, BOTH, NONE, DHCP
app_id	App Id ID used to identify/look up a child attachment behind a parent attachment	string
bms_interface_config	Application interface configuration for Bare metal server Indicate application interface configuration for Bare Metal Server.	AttachedInterfaceEntry
context_id	Context ID based on the type If type is CHILD and the parent port is on the same segment as the child port, then this field should be VIF ID of the parent port. If type is CHILD and the parent port is on a different segment, then this field should be policy path of the parent port. If type is INDEPENDENT/STATIC, then this field should be transport node ID.	string
context_type	Context Type Set to PARENT when type field is CHILD. Read only field.	string	Readonly Enum: PARENT
evpn_vlans	Evpn tenant VLAN IDs the Parent logical-port serves. List of Evpn tenant VLAN IDs the Parent logical-port serves in Evpn Route-Server mode. Only effective when attachment type is PARENT and the logical-port is attached to vRouter VM.	array of string	Minimum items: 0 Maximum items: 1000
hyperbus_mode	Hyperbus mode Flag to indicate if hyperbus configuration is required.	string	Enum: ENABLE, DISABLE Default: "DISABLE"
id	Port attachment ID VIF UUID on NSX Manager. If the attachement type is PARENT, this property is required.	string
traffic_tag	VLAN ID Not valid when type field is INDEPENDENT, mainly used to identify traffic from different ports in container use case.	VlanID
type	Attachement type Type of port attachment. STATIC is added to replace INDEPENDENT. INDEPENDENT type and PARENT type are deprecated.	string	Enum: PARENT, CHILD, INDEPENDENT, STATIC

PortDiscoveryProfileBindingMap (schema)

Port Discovery Profile binding map

This entity will be used to establish association between discovery
profile and Port. Using this entity, user can specify intent for applying
discovery profile to particular Port. Port here is 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.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
ip_discovery_profile_path	IP Discovery Profile Path PolicyPath of associated IP Discovery Profile	string
mac_discovery_profile_path	Mac Discovery Profile Path PolicyPath of associated Mac Discovery Profile	string
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 PortDiscoveryProfileBindingMap	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

PortDiscoveryProfileBindingMapListRequestParameters (schema)

Port Discovery Profile Binding Map 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
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

PortDiscoveryProfileBindingMapListResult (schema)

Paged collection of Port Discovery Profile Binding Maps

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Port Discovery Profile Binding Map list results	array of PortDiscoveryProfileBindingMap	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

PortElement (schema)

A port or a port range

Examples- Single port "8080", Range of ports "8090-8095"

Name	Description	Type	Notes
PortElement	A port or a port range Examples- Single port "8080", Range of ports "8090-8095"	string

PortMirroringProfile (schema)

Mirrors Data from source to destination

Mirrors Data from source to destination

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
description	Description of this resource	string	Maximum length: 1024 Sortable
destination_group	Destination group path Data from source group will be copied to members of destination group. Only IPSET group and group with membership criteria VM is supported. IPSET group allows only three ip's.	string	Required
direction	Direction Port mirroring profile direction	string	Enum: INGRESS, EGRESS, BIDIRECTIONAL Default: "BIDIRECTIONAL"
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
encapsulation_type	Mirror Destination encapsulation type User can provide Mirror Destination type e.g GRE, ERSPAN_TWO or ERSPAN_THREE.If profile type is REMOTE_L3_SPAN, encapsulation type is used else ignored.	string	Enum: GRE, ERSPAN_TWO, ERSPAN_THREE Default: "GRE"
erspan_id	ERSPAN session id Used by physical switch for the mirror traffic forwarding. Must be provided and only effective when encapsulation type is ERSPAN type II or type III.	int	Minimum: 0 Maximum: 1023 Default: "0"
gre_key	GRE encapsulation key User-configurable 32-bit key only for GRE	int	Minimum: 0 Default: "0"
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
profile_type	Allows user to select type of port mirroring session.	string	Enum: REMOTE_L3_SPAN, LOGICAL_SPAN Default: "REMOTE_L3_SPAN"
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value PortMirroringProfile	string
snap_length	Maximum packet length for packet truncation If this property is set, the packet will be truncated to the provided length. If this property is unset, entire packet will be mirrored.	int	Minimum: 60 Maximum: 65535
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
tcp_ip_stack	Mirror Destination encapsulation type User can provide Mirror stack or Default stack to send mirror traffic. If profile type is REMOTE_L3_SPAN, tcp_ip_stack type is used else ignored.	string	Enum: Default, Mirror Default: "Default"
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

PortMirroringProfileListRequestParameters (schema)

Port mirroring profile request parameters

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

PortMirroringProfileListResult (schema)

Paged collection of port mirroring profiles

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Port Mirroring Profiles list results	array of PortMirroringProfile	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

PortMonitoringProfileBindingMap (schema)

Port Monitoring Profile binding map

This entity will be used to establish association between monitoring
profile and Port. Using this entity, user can specify intent for applying
monitoring profile to particular Port. Port here is Segment Port.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
ipfix_l2_profile_path	IPFIX L2 Profile Path PolicyPath of associated IPFIX L2 Profile	string
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
port_mirroring_profile_path	Port Mirroring Profile Path PolicyPath of associated Port Mirroring Profile	string
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value PortMonitoringProfileBindingMap	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

PortMonitoringProfileBindingMapListRequestParameters (schema)

Port Monitoring Profile Binding Map 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
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

PortMonitoringProfileBindingMapListResult (schema)

Paged collection of Port Monitoring Profile Binding Maps

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Port Monitoring Profile Binding Map list results	array of PortMonitoringProfileBindingMap	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

PortQoSProfileBindingMap (schema)

Port QoS Profile binding map

This entity will be used to establish association between qos
profile and Port. Using this entity, you can specify intent for applying
qos profile to particular Port. Port here is Segment Port.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
qos_profile_path	QoS Profile Path PolicyPath of associated QoS Profile	string
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value PortQoSProfileBindingMap	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

PortQoSProfileBindingMapListRequestParameters (schema)

Port QoS Profile Binding Map list request parameters

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

PortQoSProfileBindingMapListResult (schema)

Paged collection of Port QoS Profile Binding Maps

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Port QoS Profile Binding Map list results	array of PortQoSProfileBindingMap	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

PortSecurityProfileBindingMap (schema)

Security profile binding map for port

Contains the binding relationship between port and security profile.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 PortSecurityProfileBindingMap	string
segment_security_profile_path	Segment Security Profile Path The policy path of the asscociated Segment Security profile	string
spoofguard_profile_path	SpoofGuard Profile Path The policy path of the asscociated SpoofGuard profile	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

PortSecurityProfileBindingMapListRequestParameters (schema)

Port security profile binding map request parameters

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

PortSecurityProfileBindingMapListResult (schema)

Paged collection of port security profile binding maps

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Port security profile binding map list results	array of PortSecurityProfileBindingMap	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

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

PrefixEntry (schema)

Network prefix entry

Name	Description	Type	Notes
action	Action for the prefix list Action for the prefix list.	string	Enum: PERMIT, DENY Default: "PERMIT"
ge	Prefix length greater than or equal to Prefix length greater than or equal to.	int	Minimum: 1 Maximum: 128
le	Prefix length less than or equal to Prefix length less than or equal to.	int	Minimum: 1 Maximum: 128
network	Network prefix in CIDR format Network prefix in CIDR format. "ANY" matches all networks.	string	Required

PrefixList (schema)

A named list of prefixes for routing purposes

A named list of prefixes for routing purposes.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
prefixes	Ordered list of network prefixes Specify ordered list of network prefixes.	array of PrefixEntry	Required Minimum items: 1
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value PrefixList	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

PrefixListRequestParameters (schema)

PrefixList request parameters

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

PrefixListResult (schema)

Paged collection of PrefixLists

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	PrefixList results	array of PrefixList	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

ProfileBindingListRequestParameters (schema)

Profile binding map 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
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

ProfileBindingMap (schema)

Policy base profile binding map

This entity will be used to establish association between profile
and policy entities.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
profile_path	Profile Path PolicyPath of associated Profile	string	Required
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value ProfileBindingMap	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

ProfileSeverity (schema)

Intrusion Detection System Profile severity

Name	Description	Type	Notes
ProfileSeverity	Intrusion Detection System Profile severity	string	Enum: CRITICAL, HIGH, MEDIUM, LOW

ProfileSupportedAttributesListRequestParameters (schema)

Profile Attributes list request parameters.

Name	Description	Type	Notes
attribute_key	Fetch attributes and sub-attributes for the given attribute key It fetches attributes and subattributes for the given attribute key supported in the system which can be used for Policy Context Profile creation.	string
attribute_source	Source of the attribute, System Defined or custom It fetches attributes and sub attributes for the given attribute key based on the source of attribute which can be used for Policy Context Profile creation.	string	Enum: ALL, CUSTOM, SYSTEM Default: "SYSTEM"
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

PropertyItem (schema)

LabelValue Property

Represents a label-value pair.

Name	Description	Type	Notes
condition	Expression for evaluating condition If the condition is met then the property will be displayed. Examples of expression syntax are provided under 'example_request' section of 'CreateWidgetConfiguration' API.	string	Maximum length: 1024
field	Field of the Property Represents field value of the property.	string	Required Maximum length: 1024
heading	If true, represents the field as a heading Set to true if the field is a heading. Default is false.	boolean	Default: "False"
label	Label of the property If a field represents a heading, then label is not needed	Label
navigation	Navigation to a specified UI page Hyperlink of the specified UI page that provides details. This will be linked with value of the property.	string	Maximum length: 1024
render_configuration	Render Configuration Render configuration to be applied, if any.	array of RenderConfiguration
separator	A separator after this property If true, separates this property in a widget.	boolean	Default: "False"
type	field data type Data type of the field.	string	Required Enum: String, Number, Date, Url Maximum length: 255 Default: "String"

Protocol (schema)

This is an abstract type. Concrete child types:
HttpProtocol
HttpsProtocol
ScpProtocol
SftpProtocol

Name	Description	Type	Notes
name	Protocol name	string	Required Enum: http, https, scp, sftp

ProtocolVersion (schema)

TLS protocol version

Name	Description	Type	Notes
enabled	Enable status for this protocol version	boolean	Required
name	Name of the TLS protocol version	string	Required

QoSBaseRateLimiter (schema)

A Limiter configuration entry that specifies type and metrics

This is an abstract type. Concrete child types:
EgressRateLimiter
IngressBroadcastRateLimiter
IngressRateLimiter

Name	Description	Type	Notes
enabled		boolean	Required
resource_type	Type rate limiter	string	Required Enum: IngressRateLimiter, IngressBroadcastRateLimiter, EgressRateLimiter Default: "IngressRateLimiter"

QoSDscp (schema)

One of QoS or Encapsulated-Remote-Switched-Port-Analyzer

Dscp value is ignored in case of 'TRUSTED' DscpTrustMode.

Name	Description	Type	Notes
mode		DscpTrustMode
priority	Internal Forwarding Priority	int	Minimum: 0 Maximum: 63 Default: "0"

QoSProfile (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
class_of_service	Class of service Class of service groups similar types of traffic in the network and each type of traffic is treated as a class with its own level of service priority. The lower priority traffic is slowed down or in some cases dropped to provide better throughput for higher priority traffic.	int	Minimum: 0 Maximum: 7 Default: "0"
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
dscp		QoSDscp
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 QoSProfile	string
shaper_configurations	Array of Rate limiter configurations to applied on Segment or Port.	array of QoSBaseRateLimiter (Abstract type: pass one of the following concrete types) EgressRateLimiter IngressBroadcastRateLimiter IngressRateLimiter	Minimum items: 0 Maximum items: 3
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

QoSProfileBindingMap (schema)

Base QoS Profile Binding 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.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 QoSProfileBindingMap	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

QoSProfileListRequestParameters (schema)

QoS Profile request parameters

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

QoSProfileListResult (schema)

Paged collection of QoS profiles

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	QoS profiles list results	array of QoSProfile	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

RAConfig (schema)

Name	Description	Type	Notes
hop_limit	Hop limit The maximum number of hops through which packets can pass before being discarded.	integer	Minimum: 0 Maximum: 255 Default: "64"
prefix_lifetime	Lifetime of prefix The time interval in seconds, in which the prefix is advertised as valid.	integer	Minimum: 0 Maximum: 4294967295 Default: "2592000"
prefix_preferred_time	Prefix preferred time The time interval in seconds, in which the prefix is advertised as preferred.	integer	Minimum: 0 Maximum: 4294967295 Default: "604800"
ra_interval	RA interval Interval between 2 Router advertisement in seconds.	integer	Minimum: 4 Maximum: 1800 Default: "600"
router_lifetime	Lifetime of router Router lifetime value in seconds. A value of 0 indicates the router is not a default router for the receiving end. Any other value in this field specifies the lifetime, in seconds, associated with this router as a default router.	integer	Minimum: 0 Maximum: 65520 Default: "1800"

RAMode (schema)

Router Advertisement Mode

Router Advertisement Modes.
DISABLED - RA is disabled
SLAAC_DNS_THROUGH_RA - Stateless address auto-configuration RA for address and configuration
SLAAC_DNS_THROUGH_DHCP - SLAAC RA for address and DHCPv6 for configuration
DHCP_ADDRESS_AND_DNS_THROUGH_DHCP - DHCPv6 for address and configurations
SLAAC_AND_ADDRESS_DNS_THROUGH_DHCP - SLAAC RA and DHCPv6 for address and configurations

Name	Description	Type	Notes
RAMode	Router Advertisement Mode Router Advertisement Modes. DISABLED - RA is disabled SLAAC_DNS_THROUGH_RA - Stateless address auto-configuration RA for address and configuration SLAAC_DNS_THROUGH_DHCP - SLAAC RA for address and DHCPv6 for configuration DHCP_ADDRESS_AND_DNS_THROUGH_DHCP - DHCPv6 for address and configurations SLAAC_AND_ADDRESS_DNS_THROUGH_DHCP - SLAAC RA and DHCPv6 for address and configurations	string	Enum: DISABLED, SLAAC_DNS_THROUGH_RA, SLAAC_DNS_THROUGH_DHCP, DHCP_ADDRESS_AND_DNS_THROUGH_DHCP, SLAAC_AND_ADDRESS_DNS_THROUGH_DHCP

RaDNSConfig (schema)

Name	Description	Type	Notes
dns_server	DNS server DNS server.	array of IPv6Address	Maximum items: 8
dns_server_lifetime	Lifetime of DNS server in milliseconds	integer	Minimum: 0 Maximum: 4294967295 Default: "1800000"
domain_name	Domain name Domain name in RA message.	array of string	Maximum items: 8
domain_name_lifetime	Lifetime of Domain names in milliseconds	integer	Minimum: 0 Maximum: 4294967295 Default: "1800000"

Reaction (schema)

Reaction

Reaction represents a programmable entity which encapsulates the events
and the actions in response to the events, or simply "If This Then That".

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
actions	Reaction Actions Actions that need to be taken when the events occur. These actions must appear in the order that they need to be taken in. This field can be interpreted as the HOW of the Reaction, or simply as "Then That".	array of Action (Abstract type: pass one of the following concrete types) PatchResources SetFields	Required Minimum items: 1 Maximum items: 1
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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
events	Reaction Events Events that provide contextual variables about what the reaction should react to. This field can be interpreted as the WHAT of the Reaction, or simply as "If This" Clause.	array of Event	Required Minimum items: 1 Maximum items: 1
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 Reaction	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

RealizationListRequestParameters (schema)

Realization list request params

List request params for the pass through type api that get data from the
Enforcement point. The basic requirement for these kind of APIs is
filtering by Enforcement point.

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
enforcement_point_path	String Path of the enforcement point The path of the enforcement point from which the list of members needs to be fetched. Forward slashes must be escaped using %2F.	string
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

RealizedStateRequestParameter (schema)

Binding between Intent and Enforcement Point Paths

Request parameter that represents a binding between an intent path and
enforcement point path. A request on the realized state can be parameterized
with this pair and will be evaluted as follows:
- {intent_path}: the request is evaluated on all enforcement points for
the given intent.
- {intent_path, enforcement_point_path}: the request is evaluated only on
the given enforcement point for the given intent.

Name	Description	Type	Notes
enforcement_point_path	String Path of the enforcement point enforcement point path, forward slashes must be escaped using %2F	string
intent_path	String Path of the intent object Intent path of object, forward slashes must be escaped using %2F	string	Required

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.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	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	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
parent_path	Path of its parent Path of its parent	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_api	Realization API of this object on enforcement point	string
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
runtime_error	String representation of runtime error It define the root cause for runtime error.	string
runtime_status	String representation of runtime status Possible values could be UP, DOWN, UNKNOWN, DEGRADED This list is not exhaustive.	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: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

RealizedVirtualMachineListResult (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Paged Collection of VMs	array of RealizedVirtualMachine
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

RecommendedFeaturePermission (schema)

Recommended Feature Permission

Name	Description	Type	Notes
recommended_permissions	Permission	array of string	Required
src_features	List of source features	array of string	Required
target_feature	Feature	string	Required

RecommendedFeaturePermissionListResult (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	List results	array of RecommendedFeaturePermission	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

RedirectionPolicy (schema)

Contains ordered list of rules and path to PolicyServiceInstance

Ordered list of rules long with the path of PolicyServiceInstance
to which the traffic needs to be redirected. |
Please note that the scope property must be provided for NS redirection |
policy if redirect to is a service chain. For NS, when redirect to is not |
to the service chain, and scope is specified on RedirectionPolicy, it |
will be ignored. The scope will be determined from redirect to path |
instead. For EW policy, scope must not be supplied in the request. |
Path to either Tier0 or Tier1 is allowed as the scope. Only 1 path |
can be specified as a scope. |
Also, note that, if stateful flag is not sent, it will be treated as true.
If statelessness is intended, false must be sent explicitly as the value |
for stateful field.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
category	A way to classify a security policy, if needed. - Distributed Firewall - Policy framework provides five pre-defined categories for classifying a security policy. They are "Ethernet","Emergency", "Infrastructure" "Environment" and "Application". There is a pre-determined order in which the policy framework manages the priority of these security policies. Ethernet category is for supporting layer 2 firewall rules. The other four categories are applicable for layer 3 rules. Amongst them, the Emergency category has the highest priority followed by Infrastructure, Environment and then Application rules. Administrator can choose to categorize a security policy into the above categories or can choose to leave it empty. If empty it will have the least precedence w.r.t the above four categories. - Edge Firewall - Policy Framework for Edge Firewall provides six pre-defined categories "Emergency", "SystemRules", "SharedPreRules", "LocalGatewayRules", "AutoServiceRules" and "Default", in order of priority of rules. All categories are allowed for Gatetway Policies that belong to 'default' Domain. However, for user created domains, category is restricted to "SharedPreRules" or "LocalGatewayRules" only. Also, the users can add/modify/delete rules from only the "SharedPreRules" and "LocalGatewayRules" categories. If user doesn't specify the category then defaulted to "Rules". System generated category is used by NSX created rules, for example BFD rules. Autoplumbed category used by NSX verticals to autoplumb data path rules. Finally, "Default" category is the placeholder default rules with lowest in the order of priority.	string
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
comments	SecurityPolicy lock/unlock comments Comments for security policy lock/unlock.	string
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
internal_sequence_number	Internal sequence number This field is to indicate the internal sequence number of a policy with respect to the policies across categories.	int	Readonly
is_default	Default policy flag A flag to indicate whether policy is a default policy.	boolean	Readonly
lock_modified_by	User who locked the security policy ID of the user who last modified the lock for the secruity policy.	string	Readonly
lock_modified_time	SecuirtyPolicy locked/unlocked time SecurityPolicy locked/unlocked time in epoch milliseconds.	EpochMsTimestamp	Readonly
locked	Lock a security policy Indicates whether a security policy should be locked. If the security policy is locked by a user, then no other user would be able to modify this security policy. Once the user releases the lock, other users can update this security policy.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
north_south	Flag to denote whether it is north south policy This is the read only flag which will state the direction of this | redirection policy. True denotes that it is NORTH-SOUTH and false | value means it is an EAST-WEST redirection policy.	boolean	Readonly
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
redirect_to	List of redirect to target paths Paths to which traffic will be redirected to. As of now, only 1 is | supported. Paths allowed are | 1. Policy Service Instance | 2. Service Instance Endpoint | 3. Virtual Endpoint | 4. Policy Service Chain	array of string	Maximum items: 1
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value RedirectionPolicy	string
rule_count	Rule count The count of rules in the policy.	int	Readonly
rules	Redirection rules that are a part of this RedirectionPolicy Redirection rules that are a part of this RedirectionPolicy. At max, there can be 1000 rules in a given RedirectPolicy.	array of RedirectionRule	Maximum items: 1000
scheduler_path	Path to the scheduler for time based scheduling Provides a mechanism to apply the rules in this policy for a specified time duration.	string
scope	The list of group paths where the rules in this policy will get applied. This scope will take precedence over rule level scope. Supported only for security and redirection policies. In case of RedirectionPolicy, it is expected only when the policy is NS and redirecting to service chain.	array of string	Maximum items: 128
sequence_number	Sequence number to resolve conflicts across Domains This field is used to resolve conflicts between security policies across domains. In order to change the sequence number of a policy one can fire a POST request on the policy entity with a query parameter action=revise The sequence number field will reflect the value of the computed sequence number upon execution of the above mentioned POST request. For scenarios where the administrator is using a template to update several security policies, the only way to set the sequence number is to explicitly specify the sequence number for each security policy. If no sequence number is specified in the payload, a value of 0 is assigned by default. If there are multiple policies with the same sequence number then their order is not deterministic. If a specific order of policies is desired, then one has to specify unique sequence numbers or use the POST request on the policy entity with a query parameter action=revise to let the framework assign a sequence number	int	Minimum: 0
stateful	Stateful nature of the entries within this security policy. Stateful or Stateless nature of security policy is enforced on all rules in this security policy. When it is stateful, the state of the network connects are tracked and a stateful packet inspection is performed. Layer3 security policies can be stateful or stateless. By default, they are stateful. Layer2 security policies can only be stateless.	boolean
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
tcp_strict	Enforce strict tcp handshake before allowing data packets Ensures that a 3 way TCP handshake is done before the data packets are sent. tcp_strict=true is supported only for stateful security policies. If the tcp_strict flag is not specified and the security policy is stateful, then tcp_strict will be set to true.	boolean
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

RedirectionRule (schema)

It define redirection rule for service insertion

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
action	Action The action to be applied to all the services	string	Enum: REDIRECT, DO_NOT_REDIRECT
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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. Along with paths we support IP Address of type IPv4 and IPv6. IP Address can be in one of the format(CIDR, IP Address, Range of IP Address). 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	Maximum items: 128
destinations_excluded	Negation of destination groups If set to true, the rule gets applied on all the groups that are NOT part of the destination groups. If false, the rule applies to the destination groups	boolean	Default: "False"
direction	Direction Define direction of traffic.	string	Enum: IN, OUT, IN_OUT Default: "IN_OUT"
disabled	Flag to disable the rule Flag to disable the rule. Default is enabled.	boolean	Default: "False"
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
ip_protocol	IPv4 vs IPv6 packet type Type of IP packet that should be matched while enforcing the rule. The value is set to IPV4_IPV6 for Layer3 rule if not specified. For Layer2/Ether rule the value must be null.	string	Enum: IPV4, IPV6, IPV4_IPV6
is_default	Default rule flag A flag to indicate whether rule is a default rule.	boolean	Readonly
logged	Enable logging flag Flag to enable packet logging. Default is disabled.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
notes	Text for additional notes on changes Text for additional notes on changes.	string	Maximum length: 2048
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
profiles	Layer 7 service profiles Holds the list of layer 7 service profile paths. These profiles accept attributes and sub-attributes of various network services (e.g. L4 AppId, encryption algorithm, domain name, etc) as key value pairs.	array of string	Maximum items: 128
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value RedirectionRule	string
rule_id	Unique rule ID This is a unique 4 byte positive number that is assigned by the system. This rule id is passed all the way down to the data path. The first 1GB (1000 to 2^30) will be shared by GM and LM with zebra style striped number space. For E.g 1000 to (1Million -1) by LM, (1M - 2M-1) by GM and so on.	integer	Readonly
scope	The list of policy paths where the rule is applied LR/Edge/T0/T1/LRP etc. Note that a given rule can be applied on multiple LRs/LRPs.	array of string	Maximum items: 128
sequence_number	Sequence number of the this Rule This field is used to resolve conflicts between multiple Rules under Security or Gateway Policy for a Domain If no sequence number is specified in the payload, a value of 0 is assigned by default. If there are multiple rules with the same sequence number then their order is not deterministic. If a specific order of rules is desired, then one has to specify unique sequence numbers or use the POST request on the rule entity with a query parameter action=revise to let the framework assign a sequence number	int	Minimum: 0
service_entries	Raw services In order to specify raw services this can be used, along with services which contains path to services. This can be empty or null.	array of ServiceEntry (Abstract type: pass one of the following concrete types) ALGTypeServiceEntry EtherTypeServiceEntry ICMPTypeServiceEntry IGMPTypeServiceEntry IPProtocolServiceEntry L4PortSetServiceEntry NestedServiceServiceEntry	Maximum items: 128
services	Names of services 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	Maximum items: 128
source_groups	Source group paths We need paths as duplicate names may exist for groups under different domains. Along with paths we support IP Address of type IPv4 and IPv6. IP Address can be in one of the format(CIDR, IP Address, Range of IP Address). 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	Maximum items: 128
sources_excluded	Negation of source groups If set to true, the rule gets applied on all the groups that are NOT part of the source groups. If false, the rule applies to the source groups	boolean	Default: "False"
tag	Tag applied on the rule User level field which will be printed in CLI and packet logs.	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

RegistrationToken (schema)

Appliance registration access token

Name	Description	Type	Notes
roles	List results	array of string	Required
token	Access token	string	Required
user	User delegated by token	string

RelatedApiError (schema)

Detailed information about a related API error

Name	Description	Type	Notes
details	Further details about the error	string
error_code	A numeric error code	integer
error_data	Additional data about the error	object
error_message	A description of the error	string
module_name	The module name where the error occurred	string

RelatedAttribute (schema)

Related attribute details.

Related attribute on the target resource for conditional constraints based
on related attribute value.
Example - destinationGroups/service/action is related attribute of
sourceGroups in communcation entry.

Name	Description	Type	Notes
attribute	Related attribute name on the target entity.	string	Required

RelatedAttributeConditionalExpression (schema)

Represents the leaf level type expression to express constraint as
value of realted attribute to the target. Uses
ConditionalValueConstraintExpression to constrain the target value
based on the related attribute value on the same resource.

Represents the leaf level type expression to express constraint as
value of realted attribute to the target.
Example - Constraint traget attribute 'X' (example in Constraint),
if destinationGroups contains 'vCeneter' then allow only values
"HTTPS", "HTTP" for attribute X.
{
"target":{
"target_resource_type":"CommunicationEntry",
"attribute":"services",
"path_prefix": "/infra/domains/{{DOMAIN}}/edge-communication-maps/default/communication-entries/"
},
"constraint_expression": {
"resource_type": "RelatedAttributeConditionalExpression",
"related_attribute":{
"attribute":"destinationGroups"
},
"condition" : {
"operator":"INCLUDES",
"rhs_value": ["/infra/domains/mgw/groups/VCENTER"],
"value_constraint": {
"resource_type": "ValueConstraintExpression",
"operator":"INCLUDES",
"values":["/infra/services/HTTP", "/infra/services/HTTPS"]
}
}
}
}

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
condition	Conditiona value constraint expression. Conditional value expression for target based on realted attribute value.	ConditionalValueConstraintExpression	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	Sortable
related_attribute	Related attribute.	RelatedAttribute	Required
resource_type	Must be set to the value RelatedAttributeConditionalExpression	string	Required Enum: ValueConstraintExpression, RelatedAttributeConditionalExpression, EntityInstanceCountConstraintExpression, FieldSanityConstraintExpression
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

RemainingSupportBundleNode (schema)

Name	Description	Type	Notes
node_display_name	Display name of node	string	Required Readonly
node_id	UUID of node	string	Required Readonly
status	Status of node	string	Required Readonly Enum: PENDING, PROCESSING

RemoteFileServer (schema)

Remote file server

Name	Description	Type	Notes
directory_path	Remote server directory to copy bundle files to	string	Required Pattern: "^\/[\w\-.\+~%\/]+$"
port	Server port	integer	Minimum: 1 Maximum: 65535 Default: "22"
protocol	Protocol to use to copy file	FileTransferProtocol	Required
server	Remote server hostname or IP address	string	Required

RemoteServerFingerprint (schema)

Remote server

Name	Description	Type	Notes
port	Server port	integer	Minimum: 1 Maximum: 65535 Default: "22"
server	Remote server hostname or IP address	string	Required
ssh_fingerprint	SSH fingerprint of server	string	Required

RemoteServerFingerprintRequest (schema)

Remote server

Name	Description	Type	Notes
port	Server port	integer	Minimum: 1 Maximum: 65535 Default: "22"
server	Remote server hostname or IP address	string	Required

RenderConfiguration (schema)

Render Configuration

Render configuration to be applied to the widget.

Name	Description	Type	Notes
color	Color of the entity The color to use when rendering an entity. For example, set color as 'RED' to render a portion of donut in red.	string	Enum: GREY, DARK_GREY, LIGHT_GREY, SKY_BLUE, BLUE, GREEN, YELLOW, RED, DARK_RED
condition	Expression for evaluating condition If the condition is met then the rendering specified for the condition will be applied. Examples of expression syntax are provided under 'example_request' section of 'CreateWidgetConfiguration' API.	string	Maximum length: 1024
display_value	Overridden value to display, if any If specified, overrides the field value. This can be used to display a meaningful value in situations where field value is not available or not configured.	string	Maximum length: 255
icons	Icons Icons to be applied at dashboard for widgets and UI elements.	array of Icon	Minimum items: 0
tooltip	Multi-line tooltip Multi-line text to be shown on tooltip while hovering over the UI element if the condition is met.	array of Tooltip	Minimum items: 0

ReorderRequest (schema)

Name	Description	Type	Notes
id	id of the upgrade unit group/upgrade unit before/after which the upgrade unit group/upgrade unit is to be placed	string	Required
is_before	flag indicating whether the upgrade unit group/upgrade unit is to be placed before or after the specified upgrade unit group/upgrade unit	boolean	Default: "True"

ResetStatsRequestParameters (schema)

Reset Statistics Request Parameters

Request parameters that represents an enforcement point path and category.
A request on statistics can be parameterized with this enforcement point
path and will be evaluated as follows:
- no enforcement point path specified: the request is evaluated on all enforcement
points.
- {enforcement_point_path}: the request is evaluated only on the given enforcement
point.

Name	Description	Type	Notes
category	Aggregation statistic category Aggregation statistic category to perform reset operation.	string	Required Enum: DFW, EDGE
enforcement_point_path	String Path of the enforcement point enforcement point path, forward slashes must be escaped using %2F.	string

Resource (schema)

Base class for resources

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly

ResourceFieldPointer (schema)

Resource Field Pointer

Resource Field Pointer representing the exact value within a policy object.

Name	Description	Type	Notes
field_pointer	Field Pointer Field Pointer referencing the exact field within the policy object.	string	Required
path	Resource Path Policy Path referencing a policy object. If not supplied, the field pointer will be applied to the event source.	string

ResourceInfoListResult (schema)

Collection of resource info objects

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Resource info list results	array of PolicyFineTuningResourceInfo	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

ResourceInfoSearchParameters (schema) (Experimental)

Represents search object that provides additional search capabilities

This object presents additional search capabilities over any API through free text query string. e.g. type="FirewallRuleDto".

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string
type	Type query	string

ResourceLink (schema)

A link to a related resource

Name	Description	Type	Notes
action	Optional action	string	Readonly
href	Link to resource	string	Required Readonly
rel	Link relation type Custom relation type (follows RFC 5988 where appropriate definitions exist)	string	Required Readonly

ResourceOperation (schema)

Resource Operation

Resource Operation is an Event Source that represents a resource that
is being changed at very specific points of time, with regard to
its interaction with dao layer.

Name	Description	Type	Notes
operation_types	Operation Types Operation types.	array of ResourceOperationType	Required Minimum items: 1
resource_pointer	Resource Pointer Regex path representing a regex expression on resources. This regex is used to identify the object(s) that is/are the source of the Event. For instance: specifying "Lb* | /infra/tier-0s/vmc/ipsec-vpn-services/default" as a source means that ANY resource starting with Lb or ANY resource with "/infra/tier-0s/vmc/ipsec-vpn-services/default" as path would be the source of the event in question.	string	Required
resource_type	Must be set to the value ResourceOperation	string	Required Enum: ResourceOperation, ApiRequestBody

ResourceOperationType (schema)

Resource Operation Type

Resource Operation Type represents a change in state of a resource with
regard to the interaction with DAO layer:
POST_CREATE: post-create change event.
POST_UPDATE: post-update change event.
PRE_DELETE: pre-delete change event.

Name	Description	Type	Notes
ResourceOperationType	Resource Operation Type Resource Operation Type represents a change in state of a resource with regard to the interaction with DAO layer: POST_CREATE: post-create change event. POST_UPDATE: post-update change event. PRE_DELETE: pre-delete change event.	string	Enum: POST_CREATE, POST_UPDATE, PRE_DELETE

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

ResourceSummaryDetail (schema)

Resource Summary Detail

Resource summary details represents list of resources for given resource
type with its total count.

Name	Description	Type	Notes
resource_count	Resource count Total resource count	integer	Required Readonly
resource_list	Resource List List of homogenous resources of resource type.	array of OnboardingAttribute	Readonly Maximum items: 100
resource_type	Policy Resource Type Policy resource entity type, for example: CommunicationMap, Group etc.	string	Required Readonly

RestoreStep (schema)

Restore step info

Name	Description	Type	Notes
description	Restore step description	string	Required Readonly
status		PerStepRestoreStatus
step_number	Restore step number	integer	Required Readonly
value	Restore step value	string	Required Readonly

RevisionedResource (schema)

A base class for types that track revisions

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly

Role (schema)

Role

Name	Description	Type	Notes
role	Role identifier Short identifier for the role. Must be all lower case with no spaces.	string	Required Pattern: "^[_a-z0-9-]+$"
role_display_name	Display name for role A short, human-friendly display name of the role.	string

RoleBinding (schema)

User/Group's role binding

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
identity_source_id	ID of the external identity source The ID of the external identity source that holds the referenced external entity. Currently, only external LDAP and OIDC servers are allowed.	string
identity_source_type	Identity source type	string	Enum: VIDM, LDAP, OIDC Default: "VIDM"
name	User/Group's name	string	Required Readonly
resource_type	Must be set to the value RoleBinding	string
roles	Roles	array of Role	Required Readonly
stale	Stale in vIDM Property 'stale' can be considered to have these values - absent - This type of rolebinding does not support stale property TRUE - Rolebinding is stale in vIDM meaning the user is no longer present in vIDM FALSE - Rolebinding is available in vIDM UNKNOWN - Rolebinding's state of staleness in unknown Once rolebindings become stale, they can be deleted using the API POST /aaa/role-bindings?action=delete_stale_bindings	string	Readonly Enum: TRUE, FALSE, UNKNOWN
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
type	Type	string	Required Readonly Enum: remote_user, remote_group, local_user, principal_identity

RoleBindingListResult (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	List results	array of RoleBinding	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

RoleBindingRequestParameters (schema)

Parameters to filter list of role bindings.

Pagination and Filtering parameters to get only a subset of users/groups.

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
identity_source_id	Identity source ID If provided, only return role bindings for the given identity source. Currently only supported for LDAP and OIDC identity source types.	string
identity_source_type	Identity source type	string	Enum: VIDM, LDAP, OIDC
included_fields	Comma separated list of fields that should be included in query result	string
name	User/Group name	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
role	Role ID	string
sort_ascending		boolean
sort_by	Field by which records are sorted	string
type	Type	string	Enum: remote_user, remote_group, local_user, principal_identity

RoleListResult (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	List results	array of Role	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

RoleWithFeatures (schema)

Role

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
features	Features	array of FeaturePermission	Required
id	Unique identifier of this resource	string	Sortable
resource_type	Must be set to the value RoleWithFeatures	string
role	Role identifier Short identifier for the role. Must be all lower case with no spaces.	string	Required Readonly Pattern: "^[_a-z0-9-]+$"
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

RoleWithFeaturesListResult (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	List results	array of RoleWithFeatures	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

RouteAdvertisementRule (schema)

Route advertisement rules and filtering

Name	Description	Type	Notes
action	Action to advertise routes Action to advertise filtered routes to the connected Tier0 gateway. PERMIT: Enables the advertisment DENY: Disables the advertisement	string	Required Enum: PERMIT, DENY Default: "PERMIT"
name	Display name for rule Display name should be unique.	string	Required
prefix_operator	Prefix operator to match subnets Prefix operator to filter subnets. GE prefix operator filters all the routes with prefix length greater than or equal to the subnets configured. EQ prefix operator filter all the routes with prefix length equal to the subnets configured.	string	Enum: GE, EQ Default: "GE"
route_advertisement_types	Enable different types of route advertisements Enable different types of route advertisements. When not specified, routes to IPSec VPN local-endpoint subnets (TIER1_IPSEC_LOCAL_ENDPOINT) are automatically advertised.	array of Tier1RouteAdvertisentTypes
subnets	Network CIDRs Network CIDRs to be routed.	array of string

RouteAggregationEntry (schema)

List of routes to be aggregated

Name	Description	Type	Notes
prefix	CIDR of aggregate address CIDR of aggregate address	string	Required
summary_only	Send only summarized route Send only summarized route. Summarization reduces number of routes advertised by representing multiple related routes with prefix property.	boolean	Default: "True"

RouteBasedIPSecVpnSession (schema)

Route based VPN session

A Route Based VPN is more flexible, more powerful and recommended over policy based VPN. IP Tunnel port is created and all traffic routed via tunnel port is protected. Routes can be configured statically or can be learned through BGP. A route based VPN is must for establishing redundant VPN session to remote site.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
authentication_mode	Authentication Mode Peer authentication mode. PSK - In this mode a secret key shared between local and peer sites is to be used for authentication. The secret key can be a string with a maximum length of 128 characters. CERTIFICATE - In this mode a certificate defined at the global level is to be used for authentication.	string	Enum: PSK, CERTIFICATE Default: "PSK"
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
compliance_suite	Compliance suite Compliance suite.	string	Enum: CNSA, SUITE_B_GCM_128, SUITE_B_GCM_256, PRIME, FOUNDATION, FIPS, NONE
connection_initiation_mode	Connection initiation mode Connection initiation mode used by local endpoint to establish ike connection with peer site. INITIATOR - In this mode local endpoint initiates tunnel setup and will also respond to incoming tunnel setup requests from peer gateway. RESPOND_ONLY - In this mode, local endpoint shall only respond to incoming tunnel setup requests. It shall not initiate the tunnel setup. ON_DEMAND - In this mode local endpoint will initiate tunnel creation once first packet matching the policy rule is received and will also respond to incoming initiation request.	string	Enum: INITIATOR, RESPOND_ONLY, ON_DEMAND Default: "INITIATOR"
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
dpd_profile_path	Dead peer detection (DPD) profile path Policy path referencing Dead Peer Detection (DPD) profile. Default is set to system default profile.	string
enabled	Enable/Disable IPSec VPN session Enable/Disable IPSec VPN session.	boolean	Default: "True"
force_whitelisting	Flag to add default whitelisting Gateway Policy rule for the VTI interface. If true the default firewall rule Action is set to DROP, otherwise set to ALLOW. This filed is deprecated and recommended to change Rule action filed. Note that this filed is not synchornied with default rule field.	boolean	Deprecated Default: "False"
id	Unique identifier of this resource	string	Sortable
ike_profile_path	Internet key exchange (IKE) profile path Policy path referencing IKE profile to be used. Default is set according to system default profile.	string
local_endpoint_path	Local endpoint path Policy path referencing Local endpoint.	string	Required
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
peer_address	IPV4 address of peer endpoint on remote site Public IPV4 address of the remote device terminating the VPN connection.	string	Required
peer_id	Peer id Peer ID to uniquely identify the peer site. The peer ID is the public IP address of the remote device terminating the VPN tunnel. When NAT is configured for the peer, enter the private IP address of the peer.	string	Required
psk	Pre-shared key IPSec Pre-shared key. Maximum length of this field is 128 characters.	string
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value RouteBasedIPSecVpnSession	IPSecVpnSessionResourceType	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
tcp_mss_clamping	TCP MSS Clamping TCP Maximum Segment Size Clamping Direction and Value.	TcpMaximumSegmentSizeClamping
tunnel_interfaces	IP Tunnel interfaces IP Tunnel interfaces.	array of IPSecVpnTunnelInterface	Required Minimum items: 1 Maximum items: 1
tunnel_profile_path	IPSec tunnel profile path Policy path referencing Tunnel profile to be used. Default is set to system default profile.	string
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

RouteBasedL3VpnSession (schema) (Deprecated)

Route based L3Vpn Session

A Route Based L3Vpn is more flexible, more powerful and recommended over policy based.
IP Tunnel subnet is created and all traffic routed through tunnel subnet is sent over
tunnel. Routes can be learned through BGP. A route based L3Vpn is required when using
redundant L3Vpn.

Name	Description	Type	Notes
default_rule_logging	Enable logging for whitelisted rule for the VTI interface Indicates if logging should be enabled for the default whitelisting rule for the VTI interface.	boolean	Default: "False"
force_whitelisting	Flag to add default whitelisting FW rule for the VTI interface. The default firewall rule Action is set to DROP if true otherwise set to ALLOW.	boolean	Default: "False"
resource_type	Must be set to the value RouteBasedL3VpnSession	L3VpnSessionResourceType	Required
routing_config_path	Routing configuration policy path This is a deprecated field. Any specified value is not saved and will be ignored.	string	Deprecated
tunnel_subnets	Virtual Tunnel Interface (VTI) IP subnets Virtual tunnel interface (VTI) port IP subnets to be used to configure route-based L3Vpn session. A max of one tunnel subnet is allowed.	array of TunnelSubnet	Required Minimum items: 1 Maximum items: 1

RouteDetails (schema)

BGP route details

BGP route details.

Name	Description	Type	Notes
as_path	AS path BGP AS path attribute.	string	Readonly
local_pref	Local preference BGP Local Preference attribute.	integer	Readonly
med	Multi Exit Discriminator BGP Multi Exit Discriminator attribute.	integer	Readonly
network	CIDR network address CIDR network address.	IPCIDRBlock	Required Readonly
next_hop	Next hop IP address Next hop IP address.	IPAddress	Readonly
weight	Weight BGP Weight attribute.	integer	Readonly

RouteMapEntry (schema)

Route map entry

Name	Description	Type	Notes
action	Action for the route map entry Action for the route map entry	string	Required Enum: PERMIT, DENY
community_list_matches	Community list match criteria Community list match criteria for route map. Properties community_list_matches and prefix_list_matches are mutually exclusive and cannot be used in the same route map entry.	array of CommunityMatchCriteria
prefix_list_matches	Prefix list match criteria Prefix list match criteria for route map. Properties community_list_matches and prefix_list_matches are mutually exclusive and cannot be used in the same route map entry.	array of string	Maximum items: 500
set	Set criteria for route map entry Set criteria for route map entry	RouteMapEntrySet

RouteMapEntrySet (schema)

Set criteria for route map entry

Name	Description	Type	Notes
as_path_prepend	AS path prepend to influence route selection AS path prepend to influence route selection.	string
community	Set BGP community Set BGP regular or large community for matching routes. A maximum of one value for each community type separated by space. Well-known community name, community value in aa:nn (2byte:2byte) format for regular community and community value in aa:bb:nn (4byte:4byte:4byte) format for large community are supported.	string
local_preference	Local preference to set for matching BGP routes Local preference indicates the degree of preference for one BGP route over other BGP routes. The path with highest local preference is preferred.	integer	Maximum: 4294967295 Default: "100"
med	Multi exit descriminator Multi exit descriminator (MED) is a hint to BGP neighbors about the preferred path into an autonomous system (AS) that has multiple entry points. A lower MED value is preferred over a higher value.	int	Minimum: 0 Maximum: 4294967295
prefer_global_v6_next_hop	Prefer global v6 next hop over local next hop For incoming and import route_maps on receiving both v6 global and v6 link-local address for the route, prefer to use the global address as the next hop. By default, it prefers the link-local next hop.	boolean
weight	Weight used to select certain path Weight is used to select a route when multiple routes are available to the same network. Route with the highest weight is preferred.	int	Minimum: 0 Maximum: 65535

RouterNexthop (schema)

Next hop configuration for network

Name	Description	Type	Notes
admin_distance	Cost associated with next hop route Cost associated with next hop route	int	Minimum: 1 Maximum: 255 Default: "1"
ip_address	Next hop gateway IP address Next hop gateway IP address	IPAddress
scope	Interface path associated with current route Interface path associated with current route. For example: specify a policy path referencing the IPSec VPN Session.	array of string	Minimum items: 1

RoutesPerTransportNode (schema)

Routes per transport node

BGP routes per transport node.

Name	Description	Type	Notes
routes	BGP neighbor route details Array of BGP neighbor route details for this transport node.	array of RouteDetails	Readonly
source_address	BGP neighbor source address BGP neighbor source address.	IPAddress	Readonly
transport_node_id	Transport node id	string	Required Readonly

RoutesRequestParameters (schema)

Routes request parameters

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
edge_id	UUID of edge node UUID of edge node. Edge should be member of enforcement point.	string
edge_path	Policy path of edge node Policy path of edge node. Edge should be member of enforcement point.	string
enforcement_point_path	Enforcement point path String Path of the enforcement point. When not specified, routes from all enforcement-points are returned. This property is required for retrieving routes in CSV format.	string
included_fields	Comma separated list of fields that should be included in query result	string
network_prefix	Network address filter parameter CIDR network address to filter entries in the table.	IPCIDRBlock
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
route_source	Filter routes based on the source from which route is learned Filter routes based on the source from which route is learned.	string	Enum: BGP, STATIC, CONNECTED
sort_ascending		boolean
sort_by	Field by which records are sorted	string

RoutingEntry (schema)

Routing table entry

Routing table entry.

Name	Description	Type	Notes
admin_distance	Admin distance Admin distance.	int	Readonly
interface	The policy path of the interface which is used as the next hop	string
lr_component_id	Logical router component(Service Router/Distributed Router) id	string
lr_component_type	Logical router component(Service Router/Distributed Router) type	string
network	Network CIDR Network CIDR.	string	Readonly
next_hop	Next hop address Next hop address.	IPAddress	Readonly
route_type	Route type (USER, CONNECTED, NSX_INTERNAL,..) Route type in routing table. t0c - Tier-0 Connected t0s - Tier-0 Static b - BGP t0n - Tier-0 NAT t1s - Tier-1 Static t1c - Tier-1 Connected t1n: Tier-1 NAT t1l: Tier-1 LB VIP t1ls: Tier-1 LB SNAT t1d: Tier-1 DNS FORWARDER t1ipsec: Tier-1 IPSec isr: Inter-SR	string	Readonly

RoutingTable (schema)

Routing table

Routing table.

Name	Description	Type	Notes
count	Entry count Entry count.	int	Readonly
edge_node	Transport node ID Transport node ID.	string	Readonly
route_entries	Route entries Route entries.	array of RoutingEntry	Required

RoutingTableListResult (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Paged Collection of Routes per transport node ID Paged Collection of Routes per transport node ID.	array of RoutingTable
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

RowListField (schema)

List of fields from which rows are formed

Root of the api result set for forming rows.

Name	Description	Type	Notes
alias	Alias Name Short name or alias of row list field, if any. If unspecified, the row list field can be referenced by its index in the array of row list fields as $ (for example, $0).	string	Maximum length: 255
path	JSON path JSON path to the root of the api result set for forming rows.	string	Required Maximum length: 1024

RpAddressMulticastRanges (schema)

Static IPv4 multicast address and assciated multicast group ranges

Static IPv4 multicast address and assciated multicast group ranges.

Name	Description	Type	Notes
multicast_ranges	Assciated multicast group ranges configuration Assciated multicast group ranges configuration.	array of string
rp_address	Static IPv4 multicast address configuration Static IPv4 multicast address configuration.	IPAddress	Required

Rule (schema)

A rule specifies the security policy rule between the workload groups

A rule indicates the action to be performed for various types of traffic flowing between workload 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.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
action	Action The action to be applied to all the services The JUMP_TO_APPLICATION action is only supported for rules created in the Environment category. Once a match is hit then the rule processing will jump to the rules present in the Application category, skipping all further rules in the Environment category. If no rules match in the Application category then the default application rule will be hit. This is applicable only for DFW.	string	Enum: ALLOW, DROP, REJECT, JUMP_TO_APPLICATION
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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. Along with paths we support IP Address of type IPv4 and IPv6. IP Address can be in one of the format(CIDR, IP Address, Range of IP Address). 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	Maximum items: 128
destinations_excluded	Negation of destination groups If set to true, the rule gets applied on all the groups that are NOT part of the destination groups. If false, the rule applies to the destination groups	boolean	Default: "False"
direction	Direction Define direction of traffic.	string	Enum: IN, OUT, IN_OUT Default: "IN_OUT"
disabled	Flag to disable the rule Flag to disable the rule. Default is enabled.	boolean	Default: "False"
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
ip_protocol	IPv4 vs IPv6 packet type Type of IP packet that should be matched while enforcing the rule. The value is set to IPV4_IPV6 for Layer3 rule if not specified. For Layer2/Ether rule the value must be null.	string	Enum: IPV4, IPV6, IPV4_IPV6
is_default	Default rule flag A flag to indicate whether rule is a default rule.	boolean	Readonly
logged	Enable logging flag Flag to enable packet logging. Default is disabled.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
notes	Text for additional notes on changes Text for additional notes on changes.	string	Maximum length: 2048
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
profiles	Layer 7 service profiles Holds the list of layer 7 service profile paths. These profiles accept attributes and sub-attributes of various network services (e.g. L4 AppId, encryption algorithm, domain name, etc) as key value pairs.	array of string	Maximum items: 128
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value Rule	string
rule_id	Unique rule ID This is a unique 4 byte positive number that is assigned by the system. This rule id is passed all the way down to the data path. The first 1GB (1000 to 2^30) will be shared by GM and LM with zebra style striped number space. For E.g 1000 to (1Million -1) by LM, (1M - 2M-1) by GM and so on.	integer	Readonly
scope	The list of policy paths where the rule is applied LR/Edge/T0/T1/LRP etc. Note that a given rule can be applied on multiple LRs/LRPs.	array of string	Maximum items: 128
sequence_number	Sequence number of the this Rule This field is used to resolve conflicts between multiple Rules under Security or Gateway Policy for a Domain If no sequence number is specified in the payload, a value of 0 is assigned by default. If there are multiple rules with the same sequence number then their order is not deterministic. If a specific order of rules is desired, then one has to specify unique sequence numbers or use the POST request on the rule entity with a query parameter action=revise to let the framework assign a sequence number	int	Minimum: 0
service_entries	Raw services In order to specify raw services this can be used, along with services which contains path to services. This can be empty or null.	array of ServiceEntry (Abstract type: pass one of the following concrete types) ALGTypeServiceEntry EtherTypeServiceEntry ICMPTypeServiceEntry IGMPTypeServiceEntry IPProtocolServiceEntry L4PortSetServiceEntry NestedServiceServiceEntry	Maximum items: 128
services	Names of services 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	Maximum items: 128
source_groups	Source group paths We need paths as duplicate names may exist for groups under different domains. Along with paths we support IP Address of type IPv4 and IPv6. IP Address can be in one of the format(CIDR, IP Address, Range of IP Address). 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	Maximum items: 128
sources_excluded	Negation of source groups If set to true, the rule gets applied on all the groups that are NOT part of the source groups. If false, the rule applies to the source groups	boolean	Default: "False"
tag	Tag applied on the rule User level field which will be printed in CLI and packet logs.	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

RuleInsertParameters (schema)

Parameters to tell where rule needs to be placed

Parameters to let the admin specify a relative position of a rule w.r.t to
another one in the same security policy. If the rule specified in the
anchor_path belongs to another security policy an error will be thrown.

Name	Description	Type	Notes
anchor_path	The security policy/rule 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"

RuleListRequestParameters (schema)

Rule 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
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

RuleListResult (schema)

Paged Collection of Rules

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Rule list results	array of Rule	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

RuleStatistics (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
byte_count	Bytes count Aggregated number of bytes processed by the rule.	integer	Readonly
hit_count	Hits count Aggregated number of hits received by the rule.	integer	Readonly
internal_rule_id	NSX internal rule id Realized id of the rule on NSX MP. Policy Manager can create more than one rule per policy rule, in which case this identifier helps to distinguish between the multple rules created.	string	Readonly
lr_path	Logical Router (Tier-0/Tier1) path Path of the LR on which the section is applied in case of Edge FW.	string	Readonly
max_popularity_index	The maximum popularity index Maximum value of popularity index of all rules of the type. This is aggregated statistic which are computed with lower frequency compared to individual generic rule statistics. It may have a computation delay up to 15 minutes in response to this API.	integer	Readonly
max_session_count	Maximum Sessions count Maximum value of sessions count of all rules of the type. This is aggregated statistic which are computed with lower frequency compared to generic rule statistics. It may have a computation delay up to 15 minutes in response to this API.	integer	Readonly
packet_count	Packets count Aggregated number of packets processed by the rule.	integer	Readonly
popularity_index	The index of the popularity of rule This is calculated by sessions count divided by age of the rule.	integer	Readonly
rule	Rule path Path of the rule.	string	Readonly
session_count	sessions count Aggregated number of sessions processed by the rule.	integer	Readonly
total_session_count	Total Sessions count Aggregated number of sessions processed by all the rules This is aggregated statistic which are computed with lower frequency compared to individual generic rule statistics. It may have a computation delay up to 15 minutes in response to this API.	integer	Readonly

RuleStatisticsForEnforcementPoint (schema)

Rule statistics for an enforcement point

Rule statistics for a specfic enforcement point.

Name	Description	Type	Notes
enforcement_point	Enforcement point path Rule statistics for a single enforcement point	string	Readonly
statistics	Rule Statistics Statistics for the specified enforcement point	RuleStatistics	Readonly

RuleStatisticsListResult (schema)

Paged Collection of rule statistics

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	RuleStatistics list results	array of RuleStatisticsForEnforcementPoint	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

RuntimeState (schema)

Runtime State

Runtime State.

Name	Description	Type	Notes
RuntimeState	Runtime State Runtime State.	string	Enum: UNINITIALIZED, UNKNOWN, UP, DOWN, DEGRADED, SUCCESS, FAILURE, IN_PROGRESS

ScpProtocol (schema)

Name	Description	Type	Notes
authentication_scheme	Scheme to authenticate if required	PasswordAuthenticationScheme	Required
name	Must be set to the value ScpProtocol	string	Required Enum: http, https, scp, sftp
ssh_fingerprint	SSH fingerprint of server	string	Required

SearchQueryRequest (schema)

SearchQueryRequest

Search query request.

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
query	Search query The syntax of query is described in Search API documentation.	string	Required
sort_ascending		boolean
sort_by	Field by which records are sorted	string

SearchResponse (schema)

SearchResponse

Search response

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Search results List of records matching the search query.	array of object	Readonly
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

SecurityPolicy (schema)

Contains ordered list of Rules

Ordered list of Rules.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
application_connectivity_strategy	List of Application Connectivity strategy for this SecurityPolicy This field indicates the application connectivity policy for the security policy.	array of ApplicationConnectivityStrategy	Maximum items: 2
category	A way to classify a security policy, if needed. - Distributed Firewall - Policy framework provides five pre-defined categories for classifying a security policy. They are "Ethernet","Emergency", "Infrastructure" "Environment" and "Application". There is a pre-determined order in which the policy framework manages the priority of these security policies. Ethernet category is for supporting layer 2 firewall rules. The other four categories are applicable for layer 3 rules. Amongst them, the Emergency category has the highest priority followed by Infrastructure, Environment and then Application rules. Administrator can choose to categorize a security policy into the above categories or can choose to leave it empty. If empty it will have the least precedence w.r.t the above four categories. - Edge Firewall - Policy Framework for Edge Firewall provides six pre-defined categories "Emergency", "SystemRules", "SharedPreRules", "LocalGatewayRules", "AutoServiceRules" and "Default", in order of priority of rules. All categories are allowed for Gatetway Policies that belong to 'default' Domain. However, for user created domains, category is restricted to "SharedPreRules" or "LocalGatewayRules" only. Also, the users can add/modify/delete rules from only the "SharedPreRules" and "LocalGatewayRules" categories. If user doesn't specify the category then defaulted to "Rules". System generated category is used by NSX created rules, for example BFD rules. Autoplumbed category used by NSX verticals to autoplumb data path rules. Finally, "Default" category is the placeholder default rules with lowest in the order of priority.	string
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource (Abstract type: pass one of the following concrete types) ChildRule
comments	SecurityPolicy lock/unlock comments Comments for security policy lock/unlock.	string
connectivity_strategy	Connectivity strategy applicable for this SecurityPolicy This field indicates the default connectivity policy for the security policy. Based on the connectivitiy strategy, a default rule for this security policy will be created. An appropriate action will be set on the rule based on the value of the connectivity strategy. If NONE is selected or no connectivity strategy is specified, then no default rule for the security policy gets created. The default rule that gets created will be a any-any rule and applied to entities specified in the scope of the security policy. Specifying the connectivity_strategy without specifying the scope is not allowed. The scope has to be a Group and one cannot specify IPAddress directly in the group that is used as scope. This default rule is only applicable for the Layer3 security policies. 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 WHITELIST_ENABLE_LOGGING - Whitelising with logging enabled BLACKLIST_ENABLE_LOGGING - Blacklisting with logging enabled NONE - No default rule is created.	string	Enum: WHITELIST, BLACKLIST, WHITELIST_ENABLE_LOGGING, BLACKLIST_ENABLE_LOGGING, NONE
default_rule_id	Default rule ID associated with the connectivity_strategy Based on the value of the connectivity strategy, a default rule is created for the security policy. The rule id is internally assigned by the system for this default rule.	integer	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	Sortable
internal_sequence_number	Internal sequence number This field is to indicate the internal sequence number of a policy with respect to the policies across categories.	int	Readonly
is_default	Default policy flag A flag to indicate whether policy is a default policy.	boolean	Readonly
lock_modified_by	User who locked the security policy ID of the user who last modified the lock for the secruity policy.	string	Readonly
lock_modified_time	SecuirtyPolicy locked/unlocked time SecurityPolicy locked/unlocked time in epoch milliseconds.	EpochMsTimestamp	Readonly
locked	Lock a security policy Indicates whether a security policy should be locked. If the security policy is locked by a user, then no other user would be able to modify this security policy. Once the user releases the lock, other users can update this security policy.	boolean	Default: "False"
logging_enabled	Enable logging flag Flag to enable logging for all the rules in the security policy. If the value is true then logging will be enabled for all the rules in the security policy. If the value is false, then the rule level logging value will be honored.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 SecurityPolicy	string
rule_count	Rule count The count of rules in the policy.	int	Readonly
rules	Rules that are a part of this SecurityPolicy	array of Rule
scheduler_path	Path to the scheduler for time based scheduling Provides a mechanism to apply the rules in this policy for a specified time duration.	string
scope	The list of group paths where the rules in this policy will get applied. This scope will take precedence over rule level scope. Supported only for security and redirection policies. In case of RedirectionPolicy, it is expected only when the policy is NS and redirecting to service chain.	array of string	Maximum items: 128
sequence_number	Sequence number to resolve conflicts across Domains This field is used to resolve conflicts between security policies across domains. In order to change the sequence number of a policy one can fire a POST request on the policy entity with a query parameter action=revise The sequence number field will reflect the value of the computed sequence number upon execution of the above mentioned POST request. For scenarios where the administrator is using a template to update several security policies, the only way to set the sequence number is to explicitly specify the sequence number for each security policy. If no sequence number is specified in the payload, a value of 0 is assigned by default. If there are multiple policies with the same sequence number then their order is not deterministic. If a specific order of policies is desired, then one has to specify unique sequence numbers or use the POST request on the policy entity with a query parameter action=revise to let the framework assign a sequence number	int	Minimum: 0
stateful	Stateful nature of the entries within this security policy. Stateful or Stateless nature of security policy is enforced on all rules in this security policy. When it is stateful, the state of the network connects are tracked and a stateful packet inspection is performed. Layer3 security policies can be stateful or stateless. By default, they are stateful. Layer2 security policies can only be stateless.	boolean
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
tcp_strict	Enforce strict tcp handshake before allowing data packets Ensures that a 3 way TCP handshake is done before the data packets are sent. tcp_strict=true is supported only for stateful security policies. If the tcp_strict flag is not specified and the security policy is stateful, then tcp_strict will be set to true.	boolean
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

SecurityPolicyInsertParameters (schema)

Parameters to tell where security policy needs to be placed

Parameters to let the admin specify a relative position of a security
policy w.r.t to another one.

Name	Description	Type	Notes
anchor_path	The security policy/rule 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"

SecurityPolicyListRequestParameters (schema)

SecurityPolicy 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
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
include_rule_count	Include the count of rules in policy If true, populate the rule_count field with the count of rules in the particular policy. By default, rule_count will not be populated.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

SecurityPolicyListResult (schema)

Paged Collection of security policies

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	SecurityPolicy list results	array of SecurityPolicy	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

SecurityPolicyStatistics (schema)

Security policy statistics

Aggregate statistics of all the rules in a security policy.

Name	Description	Type	Notes
internal_section_id	NSX internal section id Realized id of the section on NSX MP. Policy Manager can create more than one section per SecurityPolicy, in which case this identifier helps to distinguish between the multiple sections created.	string	Readonly
lr_path	Logical Router (Tier-0/Tier1) path Path of the LR on which the section is applied in case of Gateway Firewall.	string	Readonly
result_count	Rule stats count Total count for rule statistics	integer	Required Readonly
results	Statistics for all rules List of rule statistics.	array of RuleStatistics	Readonly Maximum items: 1000

SecurityPolicyStatisticsForEnforcementPoint (schema)

Security policy statistics for an enforcement point

Aggregate statistics of all the rules in a security policy for a specific
enforcement point.

Name	Description	Type	Notes
enforcement_point	Enforcement point path Enforcement point to fetch the statistics from.	string	Readonly
statistics	Security Policy Statistics Statistics for the specified enforcement point	SecurityPolicyStatistics	Readonly

SecurityPolicyStatisticsListResult (schema)

Paged Collection of Security Policy statistics

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Security Policy statistics list results	array of SecurityPolicyStatisticsForEnforcementPoint	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

SecurityProfileBindingMap (schema)

Base security profile binding 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.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 SecurityProfileBindingMap	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

Segment (schema)

Segment configuration

Segment configuration to attach workloads.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
address_bindings	Address bindings for the Segment Static address binding used for the Segment. This field is deprecated and will be removed in a future release. Please use address_bindings in SegmentPort to configure static bindings.	array of PortAddressBindingEntry	Deprecated Maximum items: 512
admin_state	Represents Desired state of the Segment	string	Enum: UP, DOWN Default: "UP"
advanced_config	Advanced configuration for Segment Advanced configuration for Segment.	SegmentAdvancedConfig
bridge_profiles	Bridge Profile Configuration Multiple distinct L2 bridge profiles can be configured.	array of BridgeProfileConfig
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource (Abstract type: pass one of the following concrete types) ChildDhcpStaticBindingConfig ChildSegmentDiscoveryProfileBindingMap ChildSegmentMonitoringProfileBindingMap ChildSegmentPort ChildSegmentQoSProfileBindingMap ChildSegmentSecurityProfileBindingMap ChildStaticARPConfig
connectivity_path	Policy path to the connecting Tier-0 or Tier-1 Policy path to the connecting Tier-0 or Tier-1. Valid only for segments created under Infra.	string
description	Description of this resource	string	Maximum length: 1024 Sortable
dhcp_config_path	Policy path to DHCP configuration Policy path to DHCP server or relay configuration to use for all IPv4 & IPv6 subnets configured on this segment.	string
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
domain_name	DNS domain name	string
evpn_segment	Evpn Segment Flag. Flag to indicate if the Segment is a Child-Segment of type EVPN.	boolean	Readonly
evpn_tenant_config_path	Policy path to the EvpnTenantConfig Policy path to the EvpnTenantConfig resource. Supported only for Route-Server Evpn Mode. Supported only for Overlay Segments. This will be populated for both Parent and Child segments participating in Evpn Route-Server Mode.	string
extra_configs	Extra configs on Segment This property could be used for vendor specific configuration in key value string pairs, the setting in extra_configs will be automatically inheritted by segment ports in the Segment.	array of SegmentExtraConfig
federation_config	Federation releated config Additional config for federation.	FederationConnectivityConfig	Readonly
id	Unique identifier of this resource	string	Sortable
l2_extension	Configuration for extending Segment through L2 VPN	L2Extension
ls_id	Pre-created logical switch id for Segment This property is deprecated. The property will continue to work as expected for existing segments. The segments that are newly created with ls_id will be ignored. Sepcify pre-creted logical switch id for Segment.	string	Deprecated
mac_pool_id	Allocation mac pool associated with the Segment Mac pool id that associated with a Segment.	string
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
metadata_proxy_paths	Metadata Proxy Configuration Paths Policy path to metadata proxy configuration. Multiple distinct MD proxies can be configured.	array of string
overlay_id	Overlay connectivity ID for this Segment Used for overlay connectivity of segments. The overlay_id should be allocated from the pool as definied by enforcement-point. If not provided, it is auto-allocated from the default pool on the enforcement-point.	int	Minimum: 0 Maximum: 2147483647
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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
replication_mode	Replication mode of the Segment If this field is not set for overlay segment, then the default of MTEP will be used.	string	Enum: MTEP, SOURCE Default: "MTEP"
resource_type	Must be set to the value Segment	string
subnets	Subnet configuration. Max 1 subnet	array of SegmentSubnet
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
transport_zone_path	Policy path to the transport zone Policy path to the transport zone. Supported for VLAN backed segments as well as Overlay Segments. - This field is required for VLAN backed Segments. - For overlay Segments, it is auto assigned if only one transport zone exists in the enforcement point. Default transport zone is auto assigned for overlay segments if none specified.	string
type	Segment type Segment type based on configuration.	string	Readonly Enum: ROUTED, EXTENDED, ROUTED_AND_EXTENDED, DISCONNECTED
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly
vlan_ids	VLAN ids for VLAN backed Segment VLAN ids for a VLAN backed Segment. Can be a VLAN id or a range of VLAN ids specified with '-' in between.	array of string

SegmentAdvancedConfig (schema)

Advanced configuration for Segment

Name	Description	Type	Notes
address_pool_paths	Policy path to IP address pools Policy path to IP address pools.	array of string	Maximum items: 1
connectivity	Connectivity configuration Connectivity configuration to manually connect (ON) or disconnect (OFF) a Tier1 segment from corresponding Tier1 gateway. Only valid for Tier1 Segments. This property is ignored for L2 VPN extended segments when subnets property is not specified.	string	Enum: ON, OFF Default: "ON"
hybrid	Flag to identify a hybrid logical switch When set to true, all the ports created on this segment will behave in a hybrid fashion. The hybrid port indicates to NSX that the VM intends to operate in underlay mode, but retains the ability to forward egress traffic to the NSX overlay network. This property is only applicable for segment created with transport zone type OVERLAY_STANDARD. This property cannot be modified after segment is created.	boolean	Default: "False"
inter_router	Flag to indicate if the logical switch will provide inter-router connectivity When set to true, any port attached to this logical switch will not be visible through VC/ESX UI	boolean	Default: "False"
local_egress	Flag to enable local egress This property is used to enable proximity routing with local egress. When set to true, logical router interface (downlink) connecting Segment to Tier0/Tier1 gateway is configured with prefix-length 32.	boolean	Default: "False"
local_egress_routing_policies	Local egress routing policies An ordered list of routing policies to forward traffic to the next hop.	array of LocalEgressRoutingEntry	Minimum items: 1
multicast	Enable multicast on the downlink Enable multicast on the downlink LRP created to connect the segment to Tier0/Tier1 gateway. Enabled by default, even when segment.advanced_config property is not specified.	boolean
ndra_profile_path	Policy path of Neighbor Discovery Router Advertisement profile This profile is applie dto the downlink logical router port created while attaching this semgnet to tier-0 or tier-1. If this field is empty, NDRA profile of the router is applied to the newly created port.	string
uplink_teaming_policy_name	Uplink Teaming Policy Name The name of the switching uplink teaming policy for the Segment. This name corresponds to one of the switching uplink teaming policy names listed in TransportZone associated with the Segment. See transport_zone_path property above for more details. When this property is not specified, the segment will not have a teaming policy associated with it and the host switch's default teaming policy will be used by MP.	string
urpf_mode	Unicast Reverse Path Forwarding mode This URPF mode is applied to the downlink logical router port created while attaching this segment to tier-0 or tier-1.	string	Enum: NONE, STRICT Default: "STRICT"

SegmentConfigurationState (schema)

Segment state on specific Enforcement Point

Segment state on specific Enforcement Point.

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
segment_path	Segment path	string	Readonly
state	Overall state of desired configuration Gives details of state of desired configuration. Additional enums with more details on progress/success/error states are sent for edge node. The success states are NODE_READY and TRANSPORT_NODE_READY, pending states are {VM_DEPLOYMENT_QUEUED, VM_DEPLOYMENT_IN_PROGRESS, REGISTRATION_PENDING} and other values indicate failures. "in_sync" state indicates that the desired configuration has been received by the host to which it applies, but is not yet in effect. When the configuration is actually in effect, the state will change to "success". Please note, failed state is deprecated.	string	Required Readonly Enum: pending, in_progress, success, failed, partial_success, orphaned, unknown, error, in_sync, NOT_AVAILABLE, VM_DEPLOYMENT_QUEUED, VM_DEPLOYMENT_IN_PROGRESS, VM_DEPLOYMENT_FAILED, VM_POWER_ON_IN_PROGRESS, VM_POWER_ON_FAILED, REGISTRATION_PENDING, NODE_NOT_READY, NODE_READY, VM_POWER_OFF_IN_PROGRESS, VM_POWER_OFF_FAILED, VM_UNDEPLOY_IN_PROGRESS, VM_UNDEPLOY_FAILED, VM_UNDEPLOY_SUCCESSFUL, EDGE_CONFIG_ERROR, VM_DEPLOYMENT_RESTARTED, REGISTRATION_FAILED, TRANSPORT_NODE_SYNC_PENDING, TRANSPORT_NODE_CONFIGURATION_MISSING, EDGE_HARDWARE_NOT_SUPPORTED, MULTIPLE_OVERLAY_TZS_NOT_SUPPORTED, TN_OVERLAY_TZ_IN_USE_BY_EDGE_CLUSTER, TZ_ENDPOINTS_NOT_SPECIFIED, NO_PNIC_PREPARED_IN_EDGE, APPLIANCE_INTERNAL_ERROR, VTEP_DHCP_NOT_SUPPORTED, UNSUPPORTED_HOST_SWITCH_PROFILE, UPLINK_HOST_SWITCH_PROFILE_NOT_SPECIFIED, HOSTSWITCH_PROFILE_NOT_FOUND, LLDP_SEND_ENABLED_NOT_SUPPORTED, UNSUPPORTED_NAMED_TEAMING_POLICY, LBSRCID_NOT_SUPPORTED_FOR_EDGE_VM, LACP_NOT_SUPPORTED_FOR_EDGE_VM, STANDBY_UPLINKS_NOT_SUPPORTED_FOR_EDGE_VM, MULTIPLE_ACTIVE_UPLINKS_NOT_SUPPORTED_FOR_EDGE, UNSUPPORTED_LACP_LB_ALGO_FOR_NODE, EDGE_NODE_VERSION_NOT_SUPPORTED, NO_PNIC_SPECIFIED_IN_TN, INVALID_PNIC_DEVICE_NAME, TRANSPORT_NODE_READY, VM_NETWORK_EDIT_PENDING, UNSUPPORTED_DEFAULT_TEAMING_POLICY, MPA_DISCONNECTED, VM_RENAME_PENDING, VM_CONFIG_EDIT_PENDING, VM_NETWORK_EDIT_FAILED, VM_RENAME_FAILED, VM_CONFIG_EDIT_FAILED, VM_CONFIG_DISCREPANCY, VM_NODE_REFRESH_FAILED, VM_PLACEMENT_REFRESH_FAILED, REGISTRATION_TIMEDOUT, REPLACE_FAILED, UPLINK_FROM_TEAMING_POLICY_NOT_MAPPED, LOGICAL_SWITCH_NAMED_TEAMING_HAS_NO_PNIC_BACKING, DELETE_VM_IN_REDEPLOY_FAILED, DEPLOY_VM_IN_REDEPLOY_FAILED, INSUFFICIENT_RESOURCES_IN_EDGE_NODE_FOR_SERVICE

SegmentConfigurationStateListResult (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Paged Collection of Segment State on specific Enforcement Point Paged Collection of Segment State on specific Enforcement Point	array of SegmentConfigurationState
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

SegmentCrossSiteTrafficStats (schema)

Name	Description	Type	Notes
last_update_timestamp	Last updated timestamp Timestamp when the l2 forwarder statistics was last updated.	EpochMsTimestamp	Required Readonly
rx_stats	Received data counters Total received data counters.	InterSitePortCounters	Readonly
segment_path	Policy path of Segment to attach interface Policy path of Segment to attach interface.	string	Required Readonly
tx_stats	Sent data counters Total sent data counters.	InterSitePortCounters	Readonly

SegmentDhcpConfig (schema)

DHCP configuration for segment subnet

DHCP IPv4 and IPv6 configurations are extended from this abstract class.
This is an abstract type. Concrete child types:
SegmentDhcpV4Config
SegmentDhcpV6Config

Name	Description	Type	Notes
dns_servers	DNS servers for subnet IP address of DNS servers for subnet. DNS server IP address must belong to the same address family as segment gateway_address property.	array of IPAddress	Maximum items: 2
lease_time	DHCP lease time for subnet DHCP lease time in seconds. When specified, this property overwrites lease time configured DHCP server config.	integer	Minimum: 60 Maximum: 4294967295 Default: "86400"
resource_type		string	Required Enum: SegmentDhcpV4Config, SegmentDhcpV6Config
server_address	IP address of the DHCP server IP address of the DHCP server in CIDR format. The server_address is mandatory in case this segment has provided a dhcp_config_path and it represents a DHCP server config. If this SegmentDhcpConfig is a SegmentDhcpV4Config, the address must be an IPv4 address. If this is a SegmentDhcpV6Config, the address must be an IPv6 address. This address must not overlap the ip-ranges of the subnet, or the gateway address of the subnet, or the DHCP static-binding addresses of this segment.	IPCIDRBlock

SegmentDhcpV4Config (schema)

DHCP configuration of IPv4 subnet in a segment

Name	Description	Type	Notes
dns_servers	DNS servers for subnet IP address of DNS servers for subnet. DNS server IP address must belong to the same address family as segment gateway_address property.	array of IPAddress	Maximum items: 2
lease_time	DHCP lease time for subnet DHCP lease time in seconds. When specified, this property overwrites lease time configured DHCP server config.	integer	Minimum: 60 Maximum: 4294967295 Default: "86400"
options	DHCP options IPv4 DHCP options for segment subnet.	DhcpV4Options
resource_type	Must be set to the value SegmentDhcpV4Config	string	Required Enum: SegmentDhcpV4Config, SegmentDhcpV6Config
server_address	IP address of the DHCP server IP address of the DHCP server in CIDR format. The server_address is mandatory in case this segment has provided a dhcp_config_path and it represents a DHCP server config. If this SegmentDhcpConfig is a SegmentDhcpV4Config, the address must be an IPv4 address. If this is a SegmentDhcpV6Config, the address must be an IPv6 address. This address must not overlap the ip-ranges of the subnet, or the gateway address of the subnet, or the DHCP static-binding addresses of this segment.	IPCIDRBlock

SegmentDhcpV6Config (schema)

DHCP configuration of IPv6 subnet in a segment

Name	Description	Type	Notes
dns_servers	DNS servers for subnet IP address of DNS servers for subnet. DNS server IP address must belong to the same address family as segment gateway_address property.	array of IPAddress	Maximum items: 2
domain_names	Domain names for subnet Domain names for subnet.	array of string
excluded_ranges	Excluded range of IPv6 addresses Excluded addresses to define dynamic ip allocation ranges.	array of IPElement	Minimum items: 0 Maximum items: 128
lease_time	DHCP lease time for subnet DHCP lease time in seconds. When specified, this property overwrites lease time configured DHCP server config.	integer	Minimum: 60 Maximum: 4294967295 Default: "86400"
preferred_time	Preferred time The length of time that a valid address is preferred. When the preferred lifetime expires, the address becomes deprecated.	integer	Minimum: 60 Maximum: 4294967295
resource_type	Must be set to the value SegmentDhcpV6Config	string	Required Enum: SegmentDhcpV4Config, SegmentDhcpV6Config
server_address	IP address of the DHCP server IP address of the DHCP server in CIDR format. The server_address is mandatory in case this segment has provided a dhcp_config_path and it represents a DHCP server config. If this SegmentDhcpConfig is a SegmentDhcpV4Config, the address must be an IPv4 address. If this is a SegmentDhcpV6Config, the address must be an IPv6 address. This address must not overlap the ip-ranges of the subnet, or the gateway address of the subnet, or the DHCP static-binding addresses of this segment.	IPCIDRBlock
sntp_servers	SNTP servers for subnet IPv6 address of SNTP servers for subnet.	array of IPv6Address	Maximum items: 2

SegmentDiscoveryProfileBindingMap (schema)

Segment Discovery Profile binding map

This entity will be used to establish association between discovery profile
and Segment. Using this entity, user can specify intent for applying
discovery profile to particular segments.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
ip_discovery_profile_path	IP Discovery Profile Path PolicyPath of associated IP Discovery Profile	string
mac_discovery_profile_path	Mac Discovery Profile Path PolicyPath of associated Mac Discovery Profile	string
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 SegmentDiscoveryProfileBindingMap	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

SegmentDiscoveryProfileBindingMapListRequestParameters (schema)

Segment Discovery Profile Binding Map 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
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

SegmentDiscoveryProfileBindingMapListResult (schema)

Paged collection of Segment Discovery Profile Binding Maps

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Segment Discovery Profile Binding Map list results	array of SegmentDiscoveryProfileBindingMap	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

SegmentExtraConfig (schema)

Vendor specific configuration on segment or Segment port

Segment extra config is intended for supporting vendor specific configuration on the
data path, it can be set as key value string pairs on either segment or segment port.

Name	Description	Type	Notes
config_pair	Key value pair in string for the configuration	UnboundedKeyValuePair	Required

SegmentL2ForwarderSiteSpanInfo (schema) (Experimental)

Name	Description	Type	Notes
inter_site_forwarder_status	Inter-site forwarder status per node Inter-site forwarder status per node.	array of L2ForwarderStatusPerNode	Readonly
last_update_timestamp	Last updated timestamp Timestamp when the L2 forwarder remote mac addresses was last updated.	EpochMsTimestamp	Required Readonly
remote_macs_per_site	L2 forwarder remote mac addresses per site L2 forwarder remote mac addresses per site for logical switch.	array of L2ForwarderRemoteMacsPerSite	Readonly
segment_path	Segment path Policy path of a segment.	string	Required Readonly

SegmentListRequestParameters (schema)

Segment 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
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

SegmentListResult (schema)

Paged collection of Segments

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Segment list results	array of Segment	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

SegmentMacAddressListResult (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
last_update_timestamp	Timestamp when the data was last updated; unset if data source has never updated the data.	EpochMsTimestamp	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results		array of MacTableEntry
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly
transport_node_id	Transport node identifier	string	Readonly

SegmentMonitoringProfileBindingMap (schema)

Segment Monitoring Profile binding map

This entity will be used to establish association between monitoring profile
and Segment. Using this entity, you can specify intent for applying
monitoring profile to particular segment.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
ipfix_l2_profile_path	IPFIX L2 Profile Path PolicyPath of associated IPFIX L2 Profile	string
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
port_mirroring_profile_path	Port Mirroring Profile Path PolicyPath of associated Port Mirroring Profile	string
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value SegmentMonitoringProfileBindingMap	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

SegmentMonitoringProfileBindingMapListRequestParameters (schema)

Segment Monitoring Profile Binding Map 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
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

SegmentMonitoringProfileBindingMapListResult (schema)

Paged collection of Segment Monitoring Profile Binding Maps

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Segment Monitoring Profile Binding Map list results	array of SegmentMonitoringProfileBindingMap	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

SegmentPort (schema)

Policy port object for segment

Policy port will create LogicalPort on LogicalSwitch corresponding to the Segment. Address bindings cannot be removed after realization.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
address_bindings	Address bindings for the port Static address binding used for the port.	array of PortAddressBindingEntry	Maximum items: 512
admin_state	Represents desired state of the segment port	string	Enum: UP, DOWN Default: "UP"
attachment	VIF attachment Only VIF attachment is supported	PortAttachment
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource (Abstract type: pass one of the following concrete types) ChildPortDiscoveryProfileBindingMap ChildPortMonitoringProfileBindingMap ChildPortQoSProfileBindingMap ChildPortSecurityProfileBindingMap
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
extra_configs	Extra configs on segment port This property could be used for vendor specific configuration in key value string pairs. Segment port setting will override segment setting if the same key was set on both segment and segment port.	array of SegmentExtraConfig
id	Unique identifier of this resource	string	Sortable
ignored_address_bindings	Address bindings to be ignored by IP Discovery module IP Discovery module uses various mechanisms to discover address bindings being used on each segment port. If a user would like to ignore any specific discovered address bindings or prevent the discovery of a particular set of discovered bindings, then those address bindings can be provided here. Currently IP range in CIDR format is not supported.	array of PortAddressBindingEntry	Minimum items: 0 Maximum items: 16
init_state	Initial state of this logical ports Set initial state when a new logical port is created. 'UNBLOCKED_VLAN' means new port will be unblocked on traffic in creation, also VLAN will be set with corresponding logical switch setting. This port setting can only be configured at port creation, and cannot be modified. 'RESTORE_VIF' fetches and restores VIF attachment from ESX host.	string	Enum: UNBLOCKED_VLAN, RESTORE_VIF
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 SegmentPort	string
source_site_id	source site(LM) id. This field will refer to the source site on which the segment port is discovered. This field is populated by GM, when it receives corresponding notification from LM.	string	Readonly
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

SegmentPortAttachmentState (schema)

VIF attachment state of a segment port

Name	Description	Type	Notes
attachers	VM or vmknic entities that are attached to the Segment Port	array of PortAttacher	Readonly
id	VIF ID	string	Readonly
state	State of the VIF attached to Segment Port A segment port must be in one of following states. FREE - If there are no active attachers. The port may or may not have an attachment ID configured on it. This state is applicable only to port of static type. ATTACHED - Segment port has exactly one active attacher and no further configuration is pending. ATTACHED_PENDING_CONF - Segment port has exactly one attacher, however it may not have been configured completely. Additional configuration will be provided by other nsx components. ATTACHED_IN_MOTION - Segment port has multiple active attachers. This state represents a scenario where VM is moving from one location (host or storage) to another (e.g. vmotion, vSphere HA) DETACHED - A temporary state after all port attachers have been detached. This state is applicable only to a port of ephemeral type and the port will soon be deleted.	string	Required Readonly Enum: FREE, ATTACHED, ATTACHED_PENDING_CONF, ATTACHED_IN_MOTION, DETACHED

SegmentPortListRequestParameters (schema)

SegmentPort 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
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

SegmentPortListResult (schema)

Paged collection of SegmentPort

List SegmentPort objects

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	SegmentPort list results Place holder for the list result	array of SegmentPort	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

SegmentPortMacAddressCsvListResult (schema)

Name	Description	Type	Notes
file_name	File name File name set by HTTP server if API returns CSV result as a file.	string
last_update_timestamp	Timestamp when the data was last updated; unset if data source has never updated the data.	EpochMsTimestamp	Readonly
results		array of SegmentPortMacTableCsvEntry

SegmentPortMacAddressListResult (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
last_update_timestamp	Timestamp when the data was last updated; unset if data source has never updated the data.	EpochMsTimestamp	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results		array of SegmentPortMacTableEntry
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly
transport_node_id	Transport node identifier	string	Readonly

SegmentPortMacTableCsvEntry (schema)

Name	Description	Type	Notes
mac_address	The MAC address	string	Required
mac_type	The type of the MAC address	MacAddressType	Required

SegmentPortMacTableEntry (schema)

Name	Description	Type	Notes
mac_address	The MAC address	string	Required
mac_type	The type of the MAC address	MacAddressType	Required

SegmentPortState (schema)

Realized state of the segment port on enforcement point

Contains realized state of the segment port. For example: transport node
on which the port is located, discovered and realized address bindings of
the port.

Name	Description	Type	Notes
attachment	Segment port attachment state	SegmentPortAttachmentState	Readonly
discovered_bindings	Segment port bindings discovered automatically Contains the list of address bindings for a segment port that were automatically dicovered using various snooping methods like ARP, DHCP etc.	array of AddressBindingEntry
duplicate_bindings	Duplicate segment port address bindings If any address binding discovered on the port is also found on other port on the same segment, then it is included in the duplicate bindings list along with the ID of the port with which it conflicts.	array of DuplicateAddressBindingEntry
realized_bindings	Realized segment port bindings List of segment port bindings that are realized. This list may be populated from the discovered bindings or manual user specified bindings. This binding configuration can be used by features such as firewall, spoof-guard, traceflow etc.	array of AddressBindingEntry
transport_node_ids	Identifiers of the transport nodes where the port is located	array of string

SegmentPortStatistics (schema)

Segment port statistics on specific Enforcement Point

Segment port statistics on specific Enforcement Point.

Name	Description	Type	Notes
dropped_by_security_packets		PacketsDroppedBySecurity	Readonly
last_update_timestamp	Timestamp when the data was last updated; unset if data source has never updated the data.	EpochMsTimestamp	Readonly
logical_port_id	The id of the logical port	string	Required Readonly
mac_learning		MacLearningCounters	Readonly
rx_bytes		DataCounter	Readonly
rx_packets		DataCounter	Readonly
tx_bytes		DataCounter	Readonly
tx_packets		DataCounter	Readonly

SegmentQoSProfileBindingMap (schema)

Segment QoS Profile binding map

This entity will be used to establish association between qos profile
and Segment. Using this entity, you can specify intent for applying
qos profile to particular segment.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
qos_profile_path	QoS Profile Path PolicyPath of associated QoS Profile	string
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value SegmentQoSProfileBindingMap	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

SegmentQoSProfileBindingMapListRequestParameters (schema)

Segment QoS Profile Binding Map list request parameters

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

SegmentQoSProfileBindingMapListResult (schema)

Paged collection of Segment QoS Profile Binding Maps

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Segment QoS Profile Binding Map list results	array of SegmentQoSProfileBindingMap	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

SegmentSecurityProfile (schema)

Segment Security Profile

Security features extended by policy operations for securing logical segments.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
bpdu_filter_allow	Disable BPDU filtering on this whitelist Pre-defined list of allowed MAC addresses to be excluded from BPDU filtering. List of allowed MACs - 01:80:c2:00:00:00, 01:80:c2:00:00:01, 01:80:c2:00:00:02, 01:80:c2:00:00:03, 01:80:c2:00:00:04, 01:80:c2:00:00:05, 01:80:c2:00:00:06, 01:80:c2:00:00:07, 01:80:c2:00:00:08, 01:80:c2:00:00:09, 01:80:c2:00:00:0a, 01:80:c2:00:00:0b, 01:80:c2:00:00:0c, 01:80:c2:00:00:0d, 01:80:c2:00:00:0e, 01:80:c2:00:00:0f, 00:e0:2b:00:00:00, 00:e0:2b:00:00:04, 00:e0:2b:00:00:06, 01:00:0c:00:00:00, 01:00:0c:cc:cc:cc, 01:00:0c:cc:cc:cd, 01:00:0c:cd:cd:cd, 01:00:0c:cc:cc:c0, 01:00:0c:cc:cc:c1, 01:00:0c:cc:cc:c2, 01:00:0c:cc:cc:c3, 01:00:0c:cc:cc:c4, 01:00:0c:cc:cc:c5, 01:00:0c:cc:cc:c6, 01:00:0c:cc:cc:c7	array of MACAddress	Minimum items: 0 Maximum items: 32
bpdu_filter_enable	BPDU filtering status Indicates whether BPDU filter is enabled. BPDU filtering is enabled by default.	boolean	Default: "True"
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
description	Description of this resource	string	Maximum length: 1024 Sortable
dhcp_client_block_enabled	Enable DHCP client block Filters DHCP server and/or client traffic. DHCP server blocking is enabled and client blocking is disabled by default.	boolean	Default: "False"
dhcp_client_block_v6_enabled	Enable DHCP client block v6 Filters DHCP server and/or client IPv6 traffic. DHCP server blocking is enabled and client blocking is disabled by default.	boolean	Default: "False"
dhcp_server_block_enabled	Enable DHCP server block Filters DHCP server and/or client traffic. DHCP server blocking is enabled and client blocking is disabled by default.	boolean	Default: "True"
dhcp_server_block_v6_enabled	Enable DHCP server block v6 Filters DHCP server and/or client IPv6 traffic. DHCP server blocking is enabled and client blocking is disabled by default.	boolean	Default: "True"
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
non_ip_traffic_block_enabled	Enable non IP traffic block A flag to block all traffic except IP/(G)ARP/BPDU.	boolean	Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
ra_guard_enabled	Enable Router Advertisement Guard Enable or disable Router Advertisement Guard.	boolean	Default: "False"
rate_limits	Rate limiting configuration Allows configuration of rate limits for broadcast and multicast traffic. Rate limiting is disabled by default	TrafficRateLimits
rate_limits_enabled	Enable Rate Limits Enable or disable Rate Limits	boolean	Default: "False"
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value SegmentSecurityProfile	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

SegmentSecurityProfileBindingMap (schema)

Security profile binding map for segment

Contains the binding relationship between segment and security profile.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 SegmentSecurityProfileBindingMap	string
segment_security_profile_path	Segment Security Profile Path The policy path of the asscociated Segment Security profile	string
spoofguard_profile_path	SpoofGuard Profile Path The policy path of the asscociated SpoofGuard profile	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

SegmentSecurityProfileBindingMapListRequestParameters (schema)

Segment security profile binding map request parameters

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

SegmentSecurityProfileBindingMapListResult (schema)

Paged collection of segment security profile binding maps

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Segment security profile binding map list results	array of SegmentSecurityProfileBindingMap	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

SegmentSecurityProfileListRequestParameters (schema)

Segment security profile request parameters

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

SegmentSecurityProfileListResult (schema)

Paged collection of segment security profiles

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Segment Security profile list results	array of SegmentSecurityProfile	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

SegmentStateRequestParameters (schema)

Request Parameters for Metadata Proxy Runtime Information

Request parameters that represents a segment path and enforcement_point_path.

Name	Description	Type	Notes
configuration_state	Configuration state of the segment on enforcement point	string	Enum: pending, in_progress, success, failed, partial_success, orphaned, unknown
enforcement_point_path	String Path of the enforcement point enforcement point path, forward slashes must be escaped using %2F.	string
source	The data source, either realtime or cached. If not provided, cached data is returned.	DataSourceType

SegmentStatistics (schema)

Segment statistics on specific Enforcement Point

Segment statistics on specific Enforcement Point.

Name	Description	Type	Notes
dropped_by_security_packets		PacketsDroppedBySecurity	Readonly
last_update_timestamp	Timestamp when the data was last updated; unset if data source has never updated the data.	EpochMsTimestamp	Readonly
logical_switch_id	The id of the logical Switch	string	Required Readonly
mac_learning		MacLearningCounters	Readonly
rx_bytes		DataCounter	Readonly
rx_packets		DataCounter	Readonly
tx_bytes		DataCounter	Readonly
tx_packets		DataCounter	Readonly

SegmentSubnet (schema)

Subnet configuration for segment

Name	Description	Type	Notes
dhcp_config	Additional DHCP configuration Additional DHCP configuration for current subnet.	SegmentDhcpConfig (Abstract type: pass one of the following concrete types) SegmentDhcpV4Config SegmentDhcpV6Config
dhcp_ranges	DHCP address ranges for dynamic IP allocation DHCP address ranges are used for dynamic IP allocation. Supports address range and CIDR formats. First valid host address from the first value is assigned to DHCP server IP address. Existing values cannot be deleted or modified, but additional DHCP ranges can be added.	array of IPElement	Minimum items: 1
gateway_address	Gateway IP address. Gateway IP address in CIDR format for both IPv4 and IPv6.	string
network	Network CIDR for subnet Network CIDR for this subnet calculated from gateway_addresses and prefix_len.	string	Readonly

SelectableResourceReference (schema)

Resources to take action on

Name	Description	Type	Notes
is_valid	Target validity Will be set to false if the referenced NSX resource has been deleted.	boolean	Readonly
selected	Set to true if this resource has been selected to be acted upon	boolean	Required
target_display_name	Target display name Display name of the NSX resource.	string	Readonly Maximum length: 255
target_id	Target ID Identifier of the NSX resource.	string	Maximum length: 64
target_type	Target type Type of the NSX resource.	string	Maximum length: 255

SelfResourceLink (schema)

Link to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.

Name	Description	Type	Notes
action	Optional action	string	Readonly
href	Link to resource	string	Required Readonly
rel	Link relation type Custom relation type (follows RFC 5988 where appropriate definitions exist)	string	Required Readonly

Service (schema)

Contains the information related to a service

Used while defining a CommunicationEntry. 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.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource (Abstract type: pass one of the following concrete types) ChildServiceEntry
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	Sortable
is_default	Flag for default services The flag, if true, indicates that service is created in the system by default. Such default services can't be modified/deleted.	boolean	Readonly Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 NestedServiceServiceEntry	Maximum items: 50
service_type	Type of service, EITHER or NON_ETHER	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

ServiceEntry (schema)

A Service entry that describes traffic

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

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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: IPProtocolServiceEntry, IGMPTypeServiceEntry, ICMPTypeServiceEntry, ALGTypeServiceEntry, L4PortSetServiceEntry, EtherTypeServiceEntry, NestedServiceServiceEntry
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

ServiceEntryListRequestParameters (schema)

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
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

ServiceEntryListResult (schema)

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	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Service entry list results	array of ServiceEntry (Abstract type: pass one of the following concrete types) ALGTypeServiceEntry EtherTypeServiceEntry ICMPTypeServiceEntry IGMPTypeServiceEntry IPProtocolServiceEntry L4PortSetServiceEntry NestedServiceServiceEntry	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

ServiceInstanceEndpoint (schema)

Service EndPoint for Byod Policy Service Instance

A ServiceInstanceEndpoint belongs to one ByodPolicyServiceInstance and is attached to one ServiceInterface. A ServiceInstanceEndpoint represents a redirection target for a RedirectionPolicy.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 ServiceInstanceEndpoint	string	Required Enum: VirtualEndpoint, ServiceInstanceEndpoint
service_interface_path	Service Interface path Path of Service Interface to which this ServiceInstanceEndpoint is connected.	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
target_ips	IP addresses to redirect the traffic to IPs where either inbound or outbound traffic is to be redirected.	array of IPInfo	Required Minimum items: 1 Maximum items: 1
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

ServiceInterface (schema)

Service interface configuration

Service interface configuration for internal connectivity.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 ServiceInterface	string
subnets	IP address and subnet specification for interface Specify IP address and network prefix for interface.	array of InterfaceSubnet	Required Minimum items: 1
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

ServiceInterfaceListResult (schema)

Paged collection of Service Interfaces

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Service Interface list results	array of ServiceInterface	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

ServiceListRequestParameters (schema)

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
default_service	Fetch all default services If set to true, then it will display only default services. If set to false, then it will display all user defined services. If it is not provided, then complete (default as well as user defined) list of services will be displayed.	boolean
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

ServiceListResult (schema)

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	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Service list results	array of Service	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

ServiceReference (schema)

An anchor object representing the intent to consume a given 3rd party service.

An anchor object representing the intent to consume a given 3rd party service.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Operational state of the Service. A Service's operational state can be enabled or disabled. Note that would work only for NetX type of services and would not work for Guest Introsp- ection type of Services. TRUE - The Service should be enabled FALSE - The Service should be disabled	boolean	Default: "True"
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
partner_service_name	Name of Partner Service Unique name of Partner Service to be consumed for redirection.	string	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 ServiceReference	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

ServiceSegment (schema)

Service Segment configuration

Service Segment configuration to attach Service Insertion VM.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
lr_paths	Policy paths of logical routers Policy paths of logical routers or ports | to which this Service Segment can be connected.	array of string
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 ServiceSegment	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
transport_zone_path	Policy path to the transport zone Policy path to transport zone. Only overlay transport zone is supported.	string	Required
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

ServiceType (schema)

Supported service types, that are using certificates.

Name	Description	Type	Notes
ServiceType	Supported service types, that are using certificates.	string	Enum: MGMT_CLUSTER, MGMT_PLANE, API, NOTIFICATION_COLLECTOR, SYSLOG_SERVER, RSYSLOG_CLIENT, APH, GLOBAL_MANAGER, LOCAL_MANAGER, CLIENT_AUTH, RMQ

SessionTimerProfileBindingListResult (schema)

Paged Collection of session timer profile binding maps

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Session timer profile binding maps list results	array of SessionTimerProfileBindingMap	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

SessionTimerProfileBindingMap (schema)

Policy Session Timer Profile binding map

This entity will be used to establish association between Session Timer
profile and Logical Routers.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
profile_path	Profile Path PolicyPath of associated Profile	string	Required
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value SessionTimerProfileBindingMap	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

SetFields (schema)

Set Fields

Set Fields is an action to set fields of the source event.

Name	Description	Type	Notes
field_settings	Field Settings Field Settings.	array of FieldSetting	Minimum items: 1
resource_type	Must be set to the value SetFields	string	Required Enum: PatchResources, SetFields

SftpProtocol (schema)

Name	Description	Type	Notes
authentication_scheme	Scheme to authenticate if required	PasswordAuthenticationScheme	Required
name	Must be set to the value SftpProtocol	string	Required Enum: http, https, scp, sftp
ssh_fingerprint	SSH fingerprint of server	string	Required

Site (schema)

Site

Site represents an NSX deployment having its own set of NSX clusters and
transport nodes. It may correspond to a Data Center, VMC deployment, or
NSX-Cloud deployment managed via CSM.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource (Abstract type: pass one of the following concrete types) ChildEnforcementPoint
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
fail_if_rtep_misconfigured	Fail onboarding if RTEPs misconfigured Both the local site and the remote site must have edge clusters correctly configured and remote tunnel endpoint (RTEP) interfaces must be defined, or onboarding will fail.	boolean	Default: "True"
fail_if_rtt_exceeded	Fail onboarding if maximum RTT exceeded Fail onboarding if maximum RTT exceeded.	boolean	Default: "True"
federation_config	Federation releated config System managed federation config.	GmFederationSiteConfig	Readonly
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
maximum_rtt	Maximum acceptable packet round trip time (RTT) If provided and fail_if_rtt_exceeded is true, onboarding of the site will fail if measured RTT is greater than this value.	integer	Minimum: 0 Maximum: 1000 Default: "250"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 Site	string
site_connection_info	Connection information To onboard a site, the connection information (username, password, and API thumbprint) for at least one NSX manager node in the remote site must be provided. Once the site has been successfully onboarded, the site_connection_info is discarded and authentication to the remote site occurs using an X.509 client certificate.	array of SiteNodeConnectionInfo	Maximum items: 3
site_number	12-bit system generated site number	integer	Readonly
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

SiteActionParameters (schema)

Paramters for Site delete operation

If force=true then site will be deleted even if not reachable.
NOTE - Use this with caution as Global Manager will go ahead and
offboard the site forcefully.

Name	Description	Type	Notes
force		boolean

SiteAllocationIndexForEdge (schema)

Allocation index for edge

Index for cross site allocation for edge cluster
and its members referred by gateway.

Name	Description	Type	Notes
index	Unique index across sites for gateway span Unqiue edge cluster node index across sites based on stretch of the Gateway. For example, if a Gateway is streched to sites S1 with one edge cluster of 3 nodes and site S2 with one edge cluster of 2 nodes, the in the Global Manager will allocate the index for 5 edge nodes and 2 cluster in the rage 0 to 7.	integer	Readonly
target_resource_path	Edge cluster or edge node path	string	Readonly

SiteCleanupPending (schema)

Details for cleanup of resource.

SiteCleanupPending contains information about the resource cleanup
from sites.

Name	Description	Type	Notes
marked_for_delete	Indicates whether the resource is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted.	boolean	Readonly
pending_sites	List of SpanSiteInfos List of SpanSiteInfos representing the strech of the entity.	array of SpanSiteInfo	Readonly
resource_path	Policy path of an resource. Policy resource which is either marked for delete or in process of deletion from site.	string	Readonly

SiteCleanupPendingListRequestParameters (schema)

SiteCleanupPending list request parameters

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
included_fields	Comma separated list of fields that should be included in query result	string
intent_path	String Path of a resource. String Path of a resource. Can pass multiple values.	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

SiteCleanupPendingListResult (schema)

Paged collection of SiteCleanupPending

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	SiteCleanupPending list results	array of SiteCleanupPending	Readonly
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

SiteFederationConfig (schema)

Site fedeation configuration

Site fedeation configuration.

Name	Description	Type	Notes
rtep_ips	Remote tunnel endpoint IP addresses	array of IPAddress	Readonly
site_id	Site UUID	string	Readonly
site_index	Unique site index allocated (from range 0-4095)	integer	Readonly
site_path	Site path	string	Readonly

SiteListRequestParameters (schema)

Site List Request Parameters

Site 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
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

SiteListResult (schema)

Paged Collection of Sites

Paged Collection of Sites.

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Site List Result Site list result.	array of Site	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

SiteNodeConnectionInfo (schema)

Site Node Connection Info

Credential info to connect to a node in the federated remote site.

Name	Description	Type	Notes
fqdn	Fully Qualified Domain Name of the Management Node Please specify the fqdn of the Management Node of your site.	string	Required
password	Password Password to connect to Site's Local Manager.	string
thumbprint	Thumbprint of Enforcement Point Thumbprint of Site's Local Manager in the form of a SHA-256 hash represented in lower case HEX.	string
username	Username Username to connect to Site's Local Manager.	string

SiteOnboardingPreference (schema)

User Onboarding Preference

User onboarding preference for site.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
ignore_import	Ignore Import Preference Represents user's decision to ignore onboarding option for a site. User will not be shown onboarding message or will failing onboarding when ignore status is set to 'true'.	boolean	Required Readonly
resource_type	Must be set to the value SiteOnboardingPreference	string
site_id	Site Identifier Unique site identifier.	string	Readonly
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

SnmpServiceProperties (schema)

SNMP Service properties

Name	Description	Type	Notes
communities	SNMP v1, v2c community strings	array of string	Maximum items: 1
start_on_boot	Start when system boots	boolean	Required
v2_configured	SNMP v2 is configured or not	boolean	Readonly
v3_auth_protocol	SNMP v3 auth protocol	string	Required Enum: SHA1 Default: "SHA1"
v3_configured	SNMP v3 is configured or not	boolean	Readonly
v3_priv_protocol	SNMP v3 private protocol	string	Required Enum: AES128 Default: "AES128"
v3_users	V3 users SNMP v3 users information	array of SnmpV3User	Maximum items: 1

SnmpV3User (schema)

SNMP v3 user

SNMP v3 user properties

Name	Description	Type	Notes
auth_password	Auth password SNMP v3 user auth password	string
priv_password	Private password SNMP v3 user private password	string
user_id	User ID SNMP v3 user ID	string	Required

Source (schema)

Event Source

Source that is logically deemed to be the "object" upon which the
Event in question initially occurred upon. The Source is responsible
for providing information of the occurred event. Some example sources
include:
- Resource.
- API.
This is an abstract type. Concrete child types:
ApiRequestBody
ResourceOperation

Name	Description	Type	Notes
resource_type	Resource Type Event Source resource type.	string	Required Enum: ResourceOperation, ApiRequestBody

SourceFieldEvaluation (schema)

Source Field Evaluation

Source Field Evaluation represents an evaluation on resource fields.
A source field evaluation will be evaluated against an Event Source which
is of type Resource Operation. For instance, the attribute constraint could
be related to the necessity that one of the source fields equals one of the
specified values.

Name	Description	Type	Notes
expected	Operator Arguments Expected values necessary to apply the specified operation on the source field value.	array of string	Required Minimum items: 1 Maximum items: 1
field_pointer	Field Pointer Field in the form of a pointer, describing the location of the attribute within the source of the event.	string	Required
operator	Logical Operator Logical operator.	string	Required Enum: EQ, NOT_EQ
resource_type	Must be set to the value SourceFieldEvaluation	string	Required Enum: SourceFieldEvaluation

SourceIpPersistencePurge (schema)

source ip persistence purge setting

If the persistence table is full and a new connection without a matching persistence entry is received, then by default(FULL) oldest persistence entries are purged from the table to make space for new entries. Each time purging gets triggered, a small percentage of the entries are purged. If purging is disabled(NO_PURGE) and a new incoming connection requires a persistence entry to be created, then that connection is rejected even though backend servers are available.

Name	Description	Type	Notes
SourceIpPersistencePurge	source ip persistence purge setting If the persistence table is full and a new connection without a matching persistence entry is received, then by default(FULL) oldest persistence entries are purged from the table to make space for new entries. Each time purging gets triggered, a small percentage of the entries are purged. If purging is disabled(NO_PURGE) and a new incoming connection requires a persistence entry to be created, then that connection is rejected even though backend servers are available.	string	Enum: NO_PURGE, FULL

Span (schema)

Represents strech information for federated entity.

Represents the strech information for a federated entity
available only on local manager.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 Span	string
sites	List of SpanSiteInfos List of SpanSiteInfos representing the strech of the entity.	array of SpanSiteInfo	Readonly
span_leader	Policy resource type of span leader Represents Policy resource type streached entity's span leader.	string	Readonly
span_resource	Policy resource path Represents Policy resource path of streached entity.	string	Readonly
span_resource_type	Policy resource type Policy resource type of the streached entity.	string	Readonly
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

SpanSiteInfo (schema)

Represents Site resource for Span entity.

Represents the Site resource information for a Span entity
including both the internal id as well as the site path.

Name	Description	Type	Notes
site_id	Internal ID of the Site resource Site UUID representing the Site resource	string	Readonly
site_path	Path of the Site resource Path of the Site resource	string	Readonly

SpoofGuardProfile (schema)

SpoofGuard Profile

SpoofGuard is a tool that is designed to prevent virtual machines in your
environment from sending traffic with IP addresses which are not authorized
to send traffic from. A SpoofGuard policy profile once enabled blocks the
traffic determined to be spoofed.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
address_binding_whitelist	Enable SpoofGuard If true, enable the SpoofGuard, which only allows VM sending traffic with the IPs in the whitelist.	boolean	Required Default: "False"
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 SpoofGuardProfile	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

SpoofGuardProfileListRequestParameters (schema)

SpoofGuard profile request parameters

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

SpoofGuardProfileListResult (schema)

Paged collection of SpoofGuard profiles

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	SpoofGuard profile list results	array of SpoofGuardProfile	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

SshKeyBaseProperties (schema)

Name	Description	Type	Notes
label	SSH key label (used to identify the key)	string	Required
password	Current password for user (required for users root and admin)	string

SshKeyProperties (schema)

Name	Description	Type	Notes
label	SSH key label (used to identify the key)	string	Required
password	Current password for user (required for users root and admin)	string
type	SSH key type	string	Required Pattern: "^(ecdsa-sha2-nistp256|ecdsa-sha2-nistp384|ecdsa-sha2-nistp521|ssh-dss|ssh-ed25519|ssh-rsa)$"
value	SSH key value	string	Required

SshKeyPropertiesListResult (schema)

SSH key properties query results

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	SSH key properties query results	array of SshKeyProperties	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

SshServiceProperties (schema)

SSH Service properties

Name	Description	Type	Notes
start_on_boot	Start service when system boots	boolean	Required

SslCipher (schema)

SSL cipher

Name	Description	Type	Notes
SslCipher	SSL cipher	string	Enum: TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDH_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_3DES_EDE_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256, TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384, TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384, TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256, TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256, TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384, TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384, TLS_ECDH_RSA_WITH_AES_128_CBC_SHA, TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256, TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384, TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384

SslCipherGroup (schema)

SSL cipher group

Name	Description	Type	Notes
SslCipherGroup	SSL cipher group	string	Enum: BALANCED, HIGH_SECURITY, HIGH_COMPATIBILITY, CUSTOM

SslProtocol (schema)

SSL protocol

Name	Description	Type	Notes
SslProtocol	SSL protocol	string	Enum: SSL_V2, SSL_V3, TLS_V1, TLS_V1_1, TLS_V1_2

SslTrustObjectData (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
key_algo	Key algorithm contained in this certificate	string
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
passphrase	Password for private key encryption	string
path	Absolute path of this object Absolute path of this object	string	Readonly
pem_encoded	pem encoded certificate data	string	Required
private_key	private key data	string
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value SslTrustObjectData	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

StageUpgradeRequestParameters (schema)

Stage upgrade request parameters

Parameters specified during upgrade staging request

Name	Description	Type	Notes
component_type	Component type Type of the component	string

StandaloneHostIdfwConfiguration (schema)

Standalone host idfw configuration

Idfw configuration for enable/disable idfw on standalone hosts.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
idfw_enabled	Idfw enabled flag If set to true, Idfw is enabled for standalone hosts	boolean	Required
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 StandaloneHostIdfwConfiguration	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

StatItem (schema)

Statistic of an entity

Displayed as a single number. It can be used to show the characteristics of entities such as Logical Switches, Firewall Rules, and so on. For example, number of logical switches and their admin states.

Name	Description	Type	Notes
drilldown_id	Id of drilldown widget Id of drilldown widget, if any. Id should be a valid id of an existing widget.	string
tooltip	Multi-line tooltip Multi-line text to be shown on tooltip while hovering over the stat.	array of Tooltip	Minimum items: 0
total	Total If expression for total is specified, it evaluates it. Total can be omitted if not needed to be shown.	string
value	Stat Expression for stat to be displayed.	string	Required Maximum length: 1024

StaticARPConfig (schema)

Static ARP Config

Contains Static ARP configuration for Segment.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
ip_address	IP Address	IPAddress	Required
mac_address	MAC Address	MACAddress	Required
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 StaticARPConfig	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

StaticFilter (schema)

Static filters

Name	Description	Type	Notes
display_name	Display name for static filter display name to be shown in the drop down for static filter.	string	Maximum length: 1024
value	Value of static filter Value of static filter inside dropdown filter.	string

StaticRouteBfdPeer (schema)

Static Route Bidirectional Forwarding Detection Peer

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
bfd_profile_path	Policy path to Bfd Profile Bfd Profile is not supported for IPv6 networks.	string
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
enabled	Enable BFD Peer Flag to enable BFD peer.	boolean	Default: "True"
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
peer_address	IP Address of static route next hop peer Only IPv4 addresses are supported. Only a single BFD config per peer address is allowed.	string	Required
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value StaticRouteBfdPeer	string
scope	Array of policy paths of locale services Represents the array of policy paths of locale services where this BFD peer should get relalized on. The locale service service and this BFD peer must belong to the same router. Default scope is empty.	array of string
source_addresses	List of source IP addresses Array of Tier0 external interface IP addresses. BFD peering is established from all these source addresses to the neighbor specified in peer_address. Only IPv4 addresses are supported.	array of string	Minimum items: 0 Maximum items: 8
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

StaticRouteBfdPeerListResult (schema)

Paged Colleciton of StaticRouteBfdPeer

Paged collection of StaticRouteBfdPeer.

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	StaticRouteBfdPeer list results StaticRouteBfdPeer list results.	array of StaticRouteBfdPeer	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

StaticRoutes (schema)

Static routes configuration on Tier-0 or on Tier-1

Static routes configuration on Tier-0 or Tier-1.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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_on_secondary	Flag to plumb route on secondary site When false or by default northbound routes are configured only on the primary location and not on secondary location. When true, the static route will also be configured on a secondary location. Secondary location prefers route learned from the primary location and enabling this flag secondary location can override this. This flag is not applicable if all sites are primary.	boolean	Default: "False"
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
network	Network address in CIDR format Specify network address in CIDR format.	IPElement	Required
next_hops	Next hop routes for network Specify next hop routes for network.	array of RouterNexthop	Required Minimum items: 1
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 StaticRoutes	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

StaticRoutesListRequestParameters (schema)

Static Routes 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
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

StaticRoutesListResult (schema)

Paged collection of Static Routes

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Static Routes list results	array of StaticRoutes	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

StatisticsRequestParameters (schema)

Statistics Request Parameters

Request parameters that represents an enforcement point path. A request on statistics
can be parameterized with this path and will be evaluated as follows:
- no enforcement point path specified: the request is evaluated on all enforcement
points.
- {enforcement_point_path}: the request is evaluated only on the given enforcement
point.

Name	Description	Type	Notes
enforcement_point_path	String Path of the enforcement point enforcement point path, forward slashes must be escaped using %2F.	string

StatsConfiguration (schema)

Stats Configuration

Represents configuration of a statistic for an entity. Example, number of logical switches and their admin states.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
datasources	Array of Datasource Instances with their relative urls The 'datasources' represent the sources from which data will be fetched. Currently, only NSX-API is supported as a 'default' datasource. An example of specifying 'default' datasource along with the urls to fetch data from is given at 'example_request' section of 'CreateWidgetConfiguration' API.	array of Datasource	Minimum items: 0
default_filter_value	Default filter value to be passed to datasources Default filter values to be passed to datasources. This will be used when the report is requested without filter values.	array of DefaultFilterValue
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Widget Title Title of the widget. If display_name is omitted, the widget will be shown without a title.	string	Maximum length: 255
drilldown_id	Id of drilldown widget Id of drilldown widget, if any. Id should be a valid id of an existing widget. A widget is considered as drilldown widget when it is associated with any other widget and provides more detailed information about any data item from the parent widget.	string	Maximum length: 255
feature_set	Features required to view the widget Features required to view the widget.	FeatureSet
filter	Id of filter widget for subscription Id of filter widget for subscription, if any. Id should be a valid id of an existing filter widget. Filter widget should be from the same view. Datasource URLs should have placeholder values equal to filter alias to accept the filter value on filter change.	string
filter_value_required	Flag to indicate if filter value is necessary Flag to indicate that widget will continue to work without filter value. If this flag is set to false then default_filter_value is manadatory.	boolean	Default: "True"
footer		Footer
icons	Icons Icons to be applied at dashboard for widgets and UI elements.	array of Icon
id	Unique identifier of this resource	string	Sortable
is_drilldown	Set as a drilldown widget Set to true if this widget should be used as a drilldown.	boolean	Default: "False"
label	Label of the Stats Configuration Displayed at the sections, by default. It labels the entities of sections. If label is not provided, the sections are not labelled.	Label
legend	Legend for the widget Legend to be displayed. If legend is not needed, do not include it.	Legend
navigation	Navigation to a specified UI page Hyperlink of the specified UI page that provides details.	string	Maximum length: 1024
resource_type	Must be set to the value StatsConfiguration	string	Required Readonly Enum: LabelValueConfiguration, DonutConfiguration, MultiWidgetConfiguration, ContainerConfiguration, StatsConfiguration, GridConfiguration, GraphConfiguration, CustomWidgetConfiguration, DropdownFilterWidgetConfiguration Maximum length: 255
sections	Sections	array of DonutSection	Minimum items: 0
shared	Visiblity of widgets to other users Please use the property 'shared' of View instead of this. The widgets of a shared view are visible to other users.	boolean	Deprecated
span	Horizontal span Represents the horizontal span of the widget / container.	int	Minimum: 1 Maximum: 12
stat	Expression for feching statistic of an entity Expression that fetches statistic. It can be used to show the characteristics of entities such as Logical Switches, Firewall Rules, and so on. For example, number of logical switches and their admin states. If stat is not provided, then it will not be displayed.	StatItem
sub_type	Sub-type of the StatsConfiguration A sub-type of StatsConfiguration. If sub-type is not specified the parent type is rendered. The COMPACT sub_type, conserves the space for the widget. The statistic is placed on the right side on top of the status bar and the title of the widget is placed on the left side on the top of the status bar. The COMPACT style aligns itself horizontally as per the width of the container. If multiple widgets are placed insided the container then the widgets are placed one below the other to conserve the space.	string	Enum: COMPACT
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
weight	Weightage or placement of the widget or container Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details.	int	Deprecated

StatusSummaryRequestParameters (schema)

Name	Description	Type	Notes
component_type	Component type based on which upgrade units to be filtered	string
selection_status	Flag to indicate whether to return status for only selected, only deselected or both type of upgrade units	string	Enum: SELECTED, DESELECTED, ALL Default: "ALL"
show_history	Get upgrade activity for a given component Get details of the last 16 operations performed during the upgrade of a given component.	boolean

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"
require_delete_or_override_async_response	Suppress auto-deletion of generated support bundle If the remote_file_server option has not been specified, save generated support bundle until a subsequent request either deletes or overrides the support bundle generated by the current request using the action=delete_async_response or override_async_response=true query parameters. Setting this property to true allows the NSX API client to re-download a support bundle if for example a previous download attempt fails.	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)

Arbitrary key-value pairs that may be attached to an entity

Name	Description	Type	Notes
scope	Tag scope Tag searches may optionally be restricted by scope	string	Maximum length: 128 Default: ""
tag	Tag value Identifier meaningful to user with maximum length of 256 characters	string	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	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
async_response_available	True if response for asynchronous request is available	boolean	Readonly
cancelable	True if this task can be canceled	boolean	Readonly
description	Description of the task	string	Readonly
end_time	The end time of the task in epoch milliseconds	EpochMsTimestamp	Readonly
id	Identifier for this task	string	Readonly
message	A message describing the disposition of the task	string	Readonly
progress	Task progress if known, from 0 to 100	integer	Readonly Minimum: 0 Maximum: 100
request_method	HTTP request method	string	Readonly
request_uri	URI of the method invocation that spawned this task	string	Readonly
start_time	The start time of the task in epoch milliseconds	EpochMsTimestamp	Readonly
status	Current status of the task	TaskStatus	Readonly
user	Name of the user who created this task	string	Readonly

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

TcpHeader (schema)

Name	Description	Type	Notes
dst_port	Destination port of tcp header	integer	Minimum: 0 Maximum: 65535
src_port	Source port of tcp header	integer	Minimum: 0 Maximum: 65535
tcp_flags	TCP flags (9bits)	integer	Minimum: 0 Maximum: 511

TcpMaximumSegmentSizeClamping (schema)

TCP MSS Clamping

TCP MSS Clamping Direction and Value.

Name	Description	Type	Notes
direction	Maximum Segment Size Clamping Direction Specifies the traffic direction for which to apply MSS Clamping.	string	Enum: NONE, INBOUND_CONNECTION, OUTBOUND_CONNECTION, BOTH Default: "NONE"
max_segment_size	Maximum Segment Size Value MSS defines the maximum amount of data that a host is willing to accept in a single TCP segment. This field is set in TCP header during connection establishment. To avoid packet fragmentation, you can set this field depending on uplink MTU and VPN overhead. This is an optional field and in case it is left unconfigured, best possible MSS value will be calculated based on effective mtu of uplink interface. Supported MSS range is 216 to 8960.	integer	Minimum: 108 Maximum: 8902

TcpPolicyLbMonitorProfile (schema)

PolicyLbMonitorProfile for active health checks over TCP

Active healthchecks are disabled by default and can be enabled for a
server pool by binding a health monitor to the Group through the
PolicyLbRule object. This represents active health monitoring over TCP.
Active healthchecks are initiated periodically, at a configurable
interval, to each member of the Group. Only if a healthcheck fails
consecutively for a specified number of times (fall_count) to a member
will the member status be marked DOWN. Once a member is DOWN, a specified
number of consecutive successful healthchecks (rise_count) will bring
the member back to UP state. After a healthcheck is initiated, if it
does not complete within a certain period, then also
the healthcheck is considered to be unsuccessful. Completing a
healthcheck within timeout means establishing a connection (TCP or SSL),
if applicable, sending the request and receiving the response, all within
the configured timeout.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
fall_count	Monitor fall count for active healthchecks Only if a healthcheck fails consecutively for a specified number of times, given with fall_count, to a member will the member status be marked DOWN.	integer	Default: "3"
id	Unique identifier of this resource	string	Sortable
interval	Monitor interval in seconds for active healthchecks Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group.	integer	Default: "5"
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
monitor_port	Monitor port for active healthchecks Typically, monitors perform healthchecks to Group members using the member IP address and pool_port. However, in some cases, customers prefer to run healthchecks against a different port than the pool member port which handles actual application traffic. In such cases, the port to run healthchecks against can be specified in the monitor_port value.	int	Minimum: 0 Maximum: 65535
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 TcpPolicyLbMonitorProfile	string	Required Enum: TcpPolicyLbMonitorProfile, UdpPolicyLbMonitorProfile, IcmpPolicyLbMonitorProfile, HttpPolicyLbMonitorProfile, HttpsPolicyLbMonitorProfile
rise_count	Monitor rise count for active healthchecks Once a member is DOWN, a specified number of consecutive successful healthchecks specified by rise_count will bring the member back to UP state.	integer	Default: "3"
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
timeout	Monitor timeout in seconds for active healthchecks Timeout specified in seconds. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.	integer	Default: "15"
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

TcpPolicyLbVirtualServer (schema)

PolicyLbVirtualServer handling connections over TCP

Virtual server acts as a facade to an application, receives all client
connections over TCP and distributes them among the backend servers.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
access_log_enabled	Access log enabled setting If access log is enabled, all HTTP requests sent to an L7 virtual server are logged to the access log file. Both successful requests (backend server returns 2xx) and unsuccessful requests (backend server returns 4xx or 5xx) are logged to access log, if enabled.	boolean	Default: "False"
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
ip_address	IP address of the PolicyLbVirtualServer Configures the IP address of the PolicyLbVirtualServer where it receives all client connections and distributes them among the backend servers.	IPAddress	Required
lb_persistence_profile	Persistence Profile used by PolicyLbVirtualServer Path to optional object that enables persistence on a virtual server allowing related client connections to be sent to the same backend server. Persistence is disabled by default.	string
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
ports	Virtual server port number(s) or port range(s) Ports contains a list of at least one port or port range such as "80", "1234-1236". Each port element in the list should be a single port or a single port range.	array of PortElement	Required
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value TcpPolicyLbVirtualServer	string	Required Enum: TcpPolicyLbVirtualServer, UdpPolicyLbVirtualServer, HttpPolicyLbVirtualServer, HttpsPolicyLbVirtualServer, CustomPolicyLbVirtualServer
router_path	Path to router type object for PolicyLbVirtualServer Path to router type object that PolicyLbVirtualServer connects to. The only supported router object is Network.	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
traffic_source		string
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

Tier0 (schema)

Tier-0 configuration

Tier-0 configuration for external connectivity.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
advanced_config	Advanced configuration for tier-0 NSX specific configuration for tier-0	Tier0AdvancedConfig
arp_limit	ARP limit per transport node Maximum number of ARP entries per transport node.	int	Minimum: 5000 Maximum: 50000
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource (Abstract type: pass one of the following concrete types) ChildCommunityList ChildLocaleServices ChildPolicyDnsForwarder ChildPrefixList ChildStaticRoutes ChildTier0RouteMap
default_rule_logging	Enable logging for whitelisted rule Indicates if logging should be enabled for the default whitelisting rule. This field is deprecated and recommended to change Rule logging field. Note that this field is not synchronized with default logging field.	boolean	Deprecated Default: "False"
description	Description of this resource	string	Maximum length: 1024 Sortable
dhcp_config_paths	DHCP configuration for Segments connected to Tier-0 DHCP configuration for Segments connected to Tier-0. DHCP service is configured in relay mode.	array of string	Minimum items: 0 Maximum items: 1
disable_firewall	Disable gateway firewall Disable or enable gateway fiewall.	boolean	Default: "False"
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
failover_mode	Failover mode Determines the behavior when a Tier-0 instance in ACTIVE-STANDBY high-availability mode restarts after a failure. If set to PREEMPTIVE, the preferred node will take over, even if it causes another failure. If set to NON_PREEMPTIVE, then the instance that restarted will remain secondary. This property is not used when the ha_mode property is set to ACTIVE_ACTIVE. Only applicable when edge cluster is configured in Tier0 locale-service.	string	Enum: PREEMPTIVE, NON_PREEMPTIVE Default: "NON_PREEMPTIVE"
federation_config	Federation releated config Additional config for federation.	FederationGatewayConfig	Readonly
force_whitelisting	Flag to add whitelisting FW rule during realization This field is deprecated and recommended to change Rule action field. Note that this field is not synchronized with default rule field.	boolean	Deprecated Default: "False"
ha_mode	High-availability Mode for Tier-0 Specify high-availability mode for Tier-0. Default is ACTIVE_ACTIVE. When ha_mode is changed from ACTIVE_ACTIVE to ACTIVE_STANDBY, inter SR iBGP (in BGP) is disabled. Changing ha_mode from ACTIVE_STANDBY to ACTIVE_ACTIVE will enable inter SR iBGP (in BGP) and previously configured preferred edge nodes (in Tier0 locale-service) are removed.	string	Enum: ACTIVE_ACTIVE, ACTIVE_STANDBY Default: "ACTIVE_ACTIVE"
id	Unique identifier of this resource	string	Sortable
internal_transit_subnets	Internal transit subnets in CIDR format Specify subnets that are used to assign addresses to logical links connecting service routers and distributed routers. Only IPv4 addresses are supported. When not specified, subnet 169.254.0.0/24 is assigned by default in ACTIVE_ACTIVE HA mode or 169.254.0.0/28 in ACTIVE_STANDBY mode.	array of string	Maximum items: 1
intersite_config	Inter site routing configuration Inter site routing configuration when the gateway is streched.	IntersiteGatewayConfig
ipv6_profile_paths	IPv6 NDRA and DAD profiles configuration IPv6 NDRA and DAD profiles configuration on Tier0. Either or both NDRA and/or DAD profiles can be configured.	array of string	Minimum items: 0 Maximum items: 2
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
rd_admin_field	Route distinguisher administrator address If you are using EVPN service, then route distinguisher administrator address should be defined if you need auto generation of route distinguisher on your VRF configuration.	IPAddress
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value Tier0	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
transit_subnets	Transit subnets in CIDR format Specify transit subnets that are used to assign addresses to logical links connecting tier-0 and tier-1s. Both IPv4 and IPv6 addresses are supported. When not specified, subnet 100.64.0.0/16 is configured by default.	array of string
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly
vrf_config	VRF config VRF config, required for VRF Tier0.	Tier0VrfConfig

Tier0AdvancedConfig (schema)

Advanced configuration for tier-0

NSX specific configuration for tier-0

Name	Description	Type	Notes
connectivity	Connectivity configuration Connectivity configuration to manually connect (ON) or disconnect (OFF) a Tier1 segment from corresponding Tier1 gateway. Only valid for Tier1 Segments. This property is ignored for L2 VPN extended segments when subnets property is not specified.	string	Enum: ON, OFF Default: "ON"
forwarding_up_timer	Forwarding up timer Extra time in seconds the router must wait before sending the UP notification after the peer routing session is established. Default means forward immediately. VRF logical router will set it same as parent logical router.	integer	Minimum: 0 Maximum: 300 Default: "0"

Tier0DeploymentMap (schema)

Tier-0 Deployment Map

Binding of Tier-0 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.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Absolute Path of Enforcement Point Path of enforcement point on which Tier-0 shall be deployed.	string	Required
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 Tier0DeploymentMap	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

Tier0DeploymentMapListRequestParameters (schema)

Tier0 Deployment Map List Request Parameters

Tier Deployment Map 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
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

Tier0DeploymentMapListResult (schema)

Paged Collection of Tier-0 Deployment Map

Paged collection of Tier-0 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	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Tier-0 Deployment Maps Tier-0 Deployment Maps.	array of Tier0DeploymentMap	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Tier0GatewayState (schema)

Tier0 gateway state

Name	Description	Type	Notes
auto_rds	Auto assigned Route Distingushers Object that holds auto assigned route distingushers for this gateway.	AutoRds
enforcement_point_path	Enforcement point path String Path of the enforcement point. When not specified, routes from all enforcement-points are returned.	string
ipv6_status	IPv6 DAD status for Tier0 interfaces IPv6 DAD status for interfaces configured on Tier0	array of IPv6Status
tier0_state	Tier0 state Detailed realized state information for Tier0	LogicalRouterState
tier0_status	Tier0 status Detailed realized status information for Tier0	LogicalRouterStatus

Tier0HaVipConfig (schema)

Tier0 HA VIP Config

Name	Description	Type	Notes
enabled	Flag to enable this HA VIP config.	boolean	Default: "True"
external_interface_paths	Policy paths to Tier0 external interfaces for providing redundancy Policy paths to Tier0 external interfaces which are to be paired to provide redundancy. Floating IP will be owned by one of these interfaces depending upon which edge node is Active.	array of string	Required Minimum items: 2
vip_subnets	VIP floating IP address subnets Array of IP address subnets which will be used as floating IP addresses.	array of InterfaceSubnet	Required Minimum items: 1 Maximum items: 2

Tier0Interface (schema)

Tier-0 interface configuration

Tier-0 interface configuration for external connectivity.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
access_vlan_id	Vlan id Vlan id.	VlanID
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
edge_cluster_member_index	Association of interface with edge cluster member Specify association of interface with edge cluster member. This property is deprecated, use edge_path instead. When both properties are specifed, only edge_path property is used.	int	Deprecated Minimum: 0
edge_path	Policy path to edge node Policy path to edge node to handle external connectivity. Required when interface type is EXTERNAL.	string
id	Unique identifier of this resource	string	Sortable
igmp_local_join_groups	IGMP local join groups configuration IGMP local join groups configuration.	array of IPv4Address
ipv6_profile_paths	IPv6 NDRA profile configuration Configuration IPv6 NDRA profile. Only one NDRA profile can be configured.	array of string	Minimum items: 0 Maximum items: 1
ls_id	Logical switch id to attach tier-0 interface Specify logical switch to which tier-0 interface is connected for external access. This property is deprecated, use segment_path instead. Both properties cannot be used together.	string	Deprecated
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
mtu	MTU size Maximum transmission unit (MTU) specifies the size of the largest packet that a network protocol can transmit.	int	Minimum: 64
multicast	Multicast PIM configuration Multicast PIM configuration.	Tier0InterfacePimConfig
ospf	OSPF configuration OSPF configuration.	PolicyInterfaceOspfConfig
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
proxy_arp_filters	List of proxy Address Resolution Protocol Filters Array of prefix lists used to specify filtering for ARP proxy. Prefixes in this array are used to configure ARP proxy entries on Tier-0 gateway (for uplinks).	array of string	Minimum items: 0 Maximum items: 1
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value Tier0Interface	string
segment_path	Segment to attach tier-0 interface Specify Segment to which this interface is connected to. Either segment_path or ls_id property is required.	string
subnets	IP address and subnet specification for interface Specify IP address and network prefix for interface.	array of InterfaceSubnet	Required Minimum items: 1
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
type	Interface type Interface type	string	Enum: EXTERNAL, SERVICE, LOOPBACK Default: "EXTERNAL"
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly
urpf_mode	Unicast Reverse Path Forwarding mode	string	Enum: NONE, STRICT Default: "STRICT"

Tier0InterfaceListRequestParameters (schema)

Tier-0 Interface 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
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

Tier0InterfaceListResult (schema)

Paged collection of Tier-0 Interfaces

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Tier-0 Interface list results	array of Tier0Interface	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Tier0InterfacePimConfig (schema)

Multicast PIM configuration

Multicast PIM configuration.

Name	Description	Type	Notes
enabled	enable/disable PIM configuration enable/disable PIM configuration.	boolean	Default: "False"
hello_interval	PIM hello interval at interface level PIM hello interval(seconds) at interface level.	int	Minimum: 1 Maximum: 180 Default: "30"
hold_interval	PIM hold interval at interface level PIM hold interval(seconds) at interface level.	int	Minimum: 1 Maximum: 630

Tier0ListRequestParameters (schema)

Tier-0 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
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

Tier0ListResult (schema)

Paged collection of Tier-0s

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Tier-0 list results	array of Tier0	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Tier0RouteMap (schema)

RouteMap for redistributing routes to BGP and other routing protocols

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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
entries	Ordered list of route map entries Ordered list of route map entries.	array of RouteMapEntry	Required Minimum items: 1 Maximum items: 1000
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 Tier0RouteMap	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

Tier0RouteMapListResult (schema)

Paged collection of RouteMaps

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Tier0RouteMap results	array of Tier0RouteMap	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Tier0RouteRedistributionConfig (schema)

Route Redistribution config

Name	Description	Type	Notes
bgp_enabled	Flag to enable route redistribution for BGP.	boolean	Default: "True"
ospf_enabled	Flag to enable route redistribution for OSPF.	boolean	Default: "False"
redistribution_rules	List of redistribution rules.	array of Tier0RouteRedistributionRule	Minimum items: 0 Maximum items: 5 Default: "[]"

Tier0RouteRedistributionRule (schema)

Single route redistribution rule

Name	Description	Type	Notes
destinations	List of destination for a given redistribution rule Each rule can have more than one destinations. If destinations not specified for a given rule, default destionation will be BGP	array of string	Enum: BGP, OSPF
name	Rule name	string
route_map_path	Route map to be associated with the redistribution rule	string
route_redistribution_types	List of redistribution types	array of Tier0RouteRedistributionTypes	Required

Tier0RouteRedistributionTypes (schema)

Tier-0 route redistribution types

Tier-0 route redistribution types.

TIER0_STATIC: Redistribute user added static routes.
TIER0_CONNECTED: Redistribute all subnets configured on Interfaces and
routes related to TIER0_ROUTER_LINK, TIER0_SEGMENT,
TIER0_DNS_FORWARDER_IP, TIER0_IPSEC_LOCAL_IP, TIER0_NAT types.
TIER1_STATIC: Redistribute all subnets and static routes advertised
by Tier-1s.
TIER0_EXTERNAL_INTERFACE: Redistribute external interface subnets
on Tier-0.
TIER0_LOOPBACK_INTERFACE: Redistribute loopback interface subnets
on Tier-0.
TIER0_SEGMENT: Redistribute subnets configured on Segments connected
to Tier-0.
TIER0_ROUTER_LINK: Redistribute router link port subnets on Tier-0
TIER0_SERVICE_INTERFACE: Redistribute Tier0 service interface subnets.
TIER0_DNS_FORWARDER_IP: Redistribute DNS forwarder subnets.
TIER0_IPSEC_LOCAL_IP: Redistribute IPSec subnets.
TIER0_NAT: Redistribute NAT IPs owned by Tier-0.
TIER0_EVPN_TEP_IP: Redistribute EVPN local endpoint subnets on Tier-0.
TIER1_NAT: Redistribute NAT IPs advertised by Tier-1 instances.
TIER1_LB_VIP: Redistribute LB VIP IPs advertised by Tier-1 instances.
TIER1_LB_SNAT: Redistribute LB SNAT IPs advertised by Tier-1 instances.
TIER1_DNS_FORWARDER_IP: Redistribute DNS forwarder subnets on Tier-1
instances.
TIER1_CONNECTED: Redistribute all subnets configured on Segments and
Service Interfaces.
TIER1_SERVICE_INTERFACE: Redistribute Tier1 service interface subnets.
TIER1_SEGMENT: Redistribute subnets configured on Segments connected
to Tier1.
TIER1_IPSEC_LOCAL_ENDPOINT: Redistribute IPSec VPN local-endpoint
subnets advertised by TIER1.


Route redistribution destination is BGP.

Name	Description	Type	Notes
Tier0RouteRedistributionTypes	Tier-0 route redistribution types Tier-0 route redistribution types. TIER0_STATIC: Redistribute user added static routes. TIER0_CONNECTED: Redistribute all subnets configured on Interfaces and routes related to TIER0_ROUTER_LINK, TIER0_SEGMENT, TIER0_DNS_FORWARDER_IP, TIER0_IPSEC_LOCAL_IP, TIER0_NAT types. TIER1_STATIC: Redistribute all subnets and static routes advertised by Tier-1s. TIER0_EXTERNAL_INTERFACE: Redistribute external interface subnets on Tier-0. TIER0_LOOPBACK_INTERFACE: Redistribute loopback interface subnets on Tier-0. TIER0_SEGMENT: Redistribute subnets configured on Segments connected to Tier-0. TIER0_ROUTER_LINK: Redistribute router link port subnets on Tier-0 TIER0_SERVICE_INTERFACE: Redistribute Tier0 service interface subnets. TIER0_DNS_FORWARDER_IP: Redistribute DNS forwarder subnets. TIER0_IPSEC_LOCAL_IP: Redistribute IPSec subnets. TIER0_NAT: Redistribute NAT IPs owned by Tier-0. TIER0_EVPN_TEP_IP: Redistribute EVPN local endpoint subnets on Tier-0. TIER1_NAT: Redistribute NAT IPs advertised by Tier-1 instances. TIER1_LB_VIP: Redistribute LB VIP IPs advertised by Tier-1 instances. TIER1_LB_SNAT: Redistribute LB SNAT IPs advertised by Tier-1 instances. TIER1_DNS_FORWARDER_IP: Redistribute DNS forwarder subnets on Tier-1 instances. TIER1_CONNECTED: Redistribute all subnets configured on Segments and Service Interfaces. TIER1_SERVICE_INTERFACE: Redistribute Tier1 service interface subnets. TIER1_SEGMENT: Redistribute subnets configured on Segments connected to Tier1. TIER1_IPSEC_LOCAL_ENDPOINT: Redistribute IPSec VPN local-endpoint subnets advertised by TIER1. Route redistribution destination is BGP.	string	Enum: TIER0_STATIC, TIER0_CONNECTED, TIER0_EXTERNAL_INTERFACE, TIER0_SEGMENT, TIER0_ROUTER_LINK, TIER0_SERVICE_INTERFACE, TIER0_LOOPBACK_INTERFACE, TIER0_DNS_FORWARDER_IP, TIER0_IPSEC_LOCAL_IP, TIER0_NAT, TIER0_EVPN_TEP_IP, TIER1_NAT, TIER1_STATIC, TIER1_LB_VIP, TIER1_LB_SNAT, TIER1_DNS_FORWARDER_IP, TIER1_CONNECTED, TIER1_SERVICE_INTERFACE, TIER1_SEGMENT, TIER1_IPSEC_LOCAL_ENDPOINT

Tier0StateRequestParameters (schema)

State request parameters for Tier0 gateway

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
enforcement_point_path	Enforcement point path String Path of the enforcement point. When not specified, routes from all enforcement-points are returned.	string
included_fields	Comma separated list of fields that should be included in query result	string
interface_path	Interface path for interface specific state such as IPv6 DAD state String Path of interface on current Tier0 gateway for interface specified state such as IPv6 DAD state. When not specified, IPv6 NDRA state from from all interfaces is returned.	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

Tier0VrfConfig (schema)

Tier-0 vrf configuration

Tier-0 vrf configuration.

Name	Description	Type	Notes
evpn_l2_vni_config	VRF configurations required for EVPN service in ROUTE_SERVER mode. It is required for VRF to participate in the EVPN service in ROUTE_SERVER mode.	VrfEvpnL2VniConfig
evpn_transit_vni	L3 VNI associated with the VRF for overlay traffic L3 VNI associated with the VRF for overlay traffic of ethernet virtual private network (EVPN). It must be unique and available from the VNI pool defined for EVPN service. It is required for VRF to participate in the EVPN service in INLINE mode.	int
route_distinguisher	Route distinguisher Route distinguisher with format in IPAddress: or ASN:.	string
route_targets	Route targets Route targets.	array of VrfRouteTargets	Minimum items: 1 Maximum items: 1
tier0_path	Tier0 path Default tier0 path. Cannot be modified after realization.	string	Required

Tier1 (schema)

Tier-1

Tier-1 instance configuration.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
arp_limit	ARP limit per transport node Maximum number of ARP entries per transport node.	int	Minimum: 5000 Maximum: 50000
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource (Abstract type: pass one of the following concrete types) ChildLocaleServices ChildPolicyDnsForwarder ChildSegment ChildStaticRoutes
default_rule_logging	Enable logging for whitelisted rule Indicates if logging should be enabled for the default whitelisting rule. This field is deprecated and recommended to change Rule logging field. Note that this field is not synchronized with default logging field.	boolean	Deprecated Default: "False"
description	Description of this resource	string	Maximum length: 1024 Sortable
dhcp_config_paths	DHCP configuration for Segments connected to Tier-1 DHCP configuration for Segments connected to Tier-1. DHCP service is enabled in relay mode.	array of string	Minimum items: 0 Maximum items: 1
disable_firewall	Disable gateway firewall Disable or enable gateway fiewall.	boolean	Default: "False"
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
enable_standby_relocation	Flag to enable standby service router relocation. Flag to enable standby service router relocation. Standby relocation is not enabled until edge cluster is configured for Tier1.	boolean	Default: "False"
failover_mode	Failover mode Determines the behavior when a Tier-1 instance restarts after a failure. If set to PREEMPTIVE, the preferred node will take over, even if it causes another failure. If set to NON_PREEMPTIVE, then the instance that restarted will remain secondary. Only applicable when edge cluster is configured in Tier1 locale-service.	string	Enum: PREEMPTIVE, NON_PREEMPTIVE Default: "NON_PREEMPTIVE"
federation_config	Federation releated config Additional config for federation.	FederationGatewayConfig	Readonly
force_whitelisting	Flag to add whitelisting FW rule during realization This field is deprecated and recommended to change Rule action field. Note that this field is not synchornied with default rule field.	boolean	Deprecated Default: "False"
id	Unique identifier of this resource	string	Sortable
intersite_config	Inter site routing configuration Inter site routing configuration when the gateway is streched.	IntersiteGatewayConfig
ipv6_profile_paths	IPv6 NDRA and DAD profiles configuration Configuration IPv6 NDRA and DAD profiles. Either or both NDRA and/or DAD profiles can be configured.	array of string	Minimum items: 0 Maximum items: 2
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
pool_allocation	Edge node allocation size Supports edge node allocation at different sizes for routing and load balancer service to meet performance and scalability requirements. ROUTING: Allocate edge node to provide routing services. LB_SMALL, LB_MEDIUM, LB_LARGE, LB_XLARGE: Specify size of load balancer service that will be configured on TIER1 gateway.	string	Enum: ROUTING, LB_SMALL, LB_MEDIUM, LB_LARGE, LB_XLARGE Default: "ROUTING"
qos_profile	Gateway QoS Profile configuration QoS Profile configuration for Tier1 router link connected to Tier0 gateway.	GatewayQosProfileConfig
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value Tier1	string
route_advertisement_rules	Route advertisement rules and filtering	array of RouteAdvertisementRule
route_advertisement_types	Enable different types of route advertisements Enable different types of route advertisements. When not specified, routes to IPSec VPN local-endpoint subnets (TIER1_IPSEC_LOCAL_ENDPOINT) are automatically advertised.	array of Tier1RouteAdvertisentTypes
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
tier0_path	Tier-1 connectivity to Tier-0 Specify Tier-1 connectivity to Tier-0 instance.	string
type	Tier1 type Tier1 connectivity type for reference. Property value is not validated with Tier1 configuration. ROUTED: Tier1 is connected to Tier0 gateway and routing is enabled. ISOLATED: Tier1 is not connected to any Tier0 gateway. NATTED: Tier1 is in ROUTED type with NAT configured locally.	string	Enum: ROUTED, ISOLATED, NATTED
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

Tier1DeploymentMap (schema)

Tier-1 Deployment Map

Binding of Tier-1 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.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Absolute path of Enforcement Point Path of enforcement point on which Tier-1 shall be deployed.	string	Required
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 Tier1DeploymentMap	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

Tier1GatewayState (schema)

Tier1 gateway state

Name	Description	Type	Notes
enforcement_point_path	Enforcement point path String Path of the enforcement point. When not specified, routes from all enforcement-points are returned.	string
ipv6_status	IPv6 DAD status for Tier1 interfaces IPv6 DAD status for interfaces configured on Tier1	array of IPv6Status
tier1_state	Tier1 state Detailed realized state information for Tier1	LogicalRouterState
tier1_status	Tier1 status Detailed realized status information for Tier1	LogicalRouterStatus

Tier1Interface (schema)

Tier-1 interface configuration

Tier-1 interface configuration for attaching services.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
ipv6_profile_paths	IPv6 NDRA profile configuration Configrue IPv6 NDRA profile. Only one NDRA profile can be configured.	array of string	Minimum items: 0 Maximum items: 1
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
mtu	MTU size Maximum transmission unit (MTU) specifies the size of the largest packet that a network protocol can transmit.	int	Minimum: 64
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 Tier1Interface	string
segment_path	Policy path of Segment to attach interface Policy path of Segment to which interface is connected to.	string	Required
subnets	IP address and subnet specification for interface Specify IP address and network prefix for interface.	array of InterfaceSubnet	Required Minimum items: 1
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly
urpf_mode	Unicast Reverse Path Forwarding mode	string	Enum: NONE, STRICT Default: "STRICT"

Tier1InterfaceListResult (schema)

Paged collection of Tier-1 Interfaces

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Tier-1 Interface list results	array of Tier1Interface	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Tier1ListRequestParameters (schema)

Tier-1 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
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

Tier1ListResult (schema)

Paged collection of Tier-1 instances

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Tier-1 list results	array of Tier1	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Tier1RouteAdvertisentTypes (schema)

Control routes advertised by Tier-1 instance.
TIER1_STATIC_ROUTES: Advertise all STATIC routes.
TIER1_CONNECTED: Advertise all subnets configured on connected
Interfaces and Segments.
TIER1_NAT: Advertise all NAT IP addresses.
TIER1_LB_VIP: Advertise all Load-balancer VIPs.
TIER1_LB_SNAT: Advertise all Loadbalancer SNAT IP addresses.
TIER1_DNS_FORWARDER_IP: Advertise DNS forwarder source and listener IPs
TIER1_IPSEC_LOCAL_ENDPOINT: Redistribute IPSec VPN local-endpoint subnets.

Name	Description	Type	Notes
Tier1RouteAdvertisentTypes	Control routes advertised by Tier-1 instance. TIER1_STATIC_ROUTES: Advertise all STATIC routes. TIER1_CONNECTED: Advertise all subnets configured on connected Interfaces and Segments. TIER1_NAT: Advertise all NAT IP addresses. TIER1_LB_VIP: Advertise all Load-balancer VIPs. TIER1_LB_SNAT: Advertise all Loadbalancer SNAT IP addresses. TIER1_DNS_FORWARDER_IP: Advertise DNS forwarder source and listener IPs TIER1_IPSEC_LOCAL_ENDPOINT: Redistribute IPSec VPN local-endpoint subnets.	string	Enum: TIER1_STATIC_ROUTES, TIER1_CONNECTED, TIER1_NAT, TIER1_LB_VIP, TIER1_LB_SNAT, TIER1_DNS_FORWARDER_IP, TIER1_IPSEC_LOCAL_ENDPOINT

Tier1StateRequestParameters (schema)

State request parameters for Tier1 gateway

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
enforcement_point_path	Enforcement point path String Path of the enforcement point. When not specified, routes from all enforcement-points are returned.	string
included_fields	Comma separated list of fields that should be included in query result	string
interface_path	Interface path for interface specific state such as IPv6 DAD state String Path of interface on current Tier1 gateway for interface specified state such as IPv6 DAD state. When not specified, IPv6 NDRA state from from all interfaces is returned.	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

TlsCertificate (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
description	Description of this resource	string	Maximum length: 1024 Sortable
details	list of X509Certificates.	array of X509Certificate	Readonly
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
pem_encoded	pem encoded certificate data.	string	Required
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value TlsCertificate	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

TlsCertificateList (schema)

Certificate queries result

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	TlsCertificate list.	array of TlsCertificate	Required Readonly
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

TlsCrl (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
description	Description of this resource	string	Maximum length: 1024 Sortable
details	Details of the X509Crl object Details of the X509Crl object.	X509Crl	Readonly
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
pem_encoded	Pem encoded crl data Pem encoded crl data.	string	Required
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value TlsCrl	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

TlsCrlListResult (schema)

Paged Collection of TlsCrl

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	TlsCrl list results	array of TlsCrl	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

TlsListenerCertificate (schema)

Remote TLS Listener Certificate

Returns the certificate and thumbprint of a remote TLS listener, if the
listener is running and accepting requests. If the certificate cannot be
retrieved, the result property describes the problem.

Name	Description	Type	Notes
certificate	The certificate of the TLS listener The certificate of the TLS listener.	X509Certificate	Readonly
result	Result of get certificate operation Result of get certificate operation.	string	Enum: SUCCESS, CONNECTION_TIMEOUT, NO_ROUTE_TO_HOST, CONNECTION_REFUSED
thumbprint	The SHA-256 thumbprint of the TLS listener The SHA-256 thumbprint of the TLS listener.	string	Readonly

TlsListenerEndpointAddressRequestParameters (schema)

TLS Listener Endpoint Address Request Parameters

The hostname or IP, and TCP port number of the listener to connect to.

Name	Description	Type	Notes
address	Host name or IP address of TLS listener Host name or IP address of TLS listener.	string	Required
port	TCP port number of the TLS listener TCP port number of the TLS listener	int	Required Minimum: 0 Maximum: 65535

TlsTrustData (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
key_algo	Key algorithm contained in this certificate.	string
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
passphrase	Password for private key encryption.	string
path	Absolute path of this object Absolute path of this object	string	Readonly
pem_encoded	pem encoded certificate data.	string	Required
private_key	private key data	string
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value TlsTrustData	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

TnNodeStackSpanStatus (schema)

List all L3PortMirrorSession TN nodes mirror stack health status

List all the TNs spaned in L3PortMirrorSession mirror stack health status.

Name	Description	Type	Notes
dedicated_stack_status	Mirror stack health status Show the dedicated mirror stack health status, if the TN node has the mirror stack, it will show SUCCESS or it will show FAILED.	MirrorStackStatusType	Required
detail	give detail info and reason about the vmknic and statck status Give the detail info for mirror stack and vmknic health status. If the stack or vmknic is FAILED, detail info will tell user reason why the stauts is FAILED. So that user can correct their configuration.	string	Required
last_updated_time	last updated time of TN node stack status TN miror stack status will be updated periodically, this item indicates the lastest timestamp of TN node stack status is updated.	EpochMsTimestamp	Required
tn_node_id	TN node ID that configured L3PortMirrorSession mirror stack For L3PortMirrorSession configured mirror stack, show the TN node UUID which spaned in L3PortMirrorSession.	string
tn_node_name	TN node name that configured L3SPAN mirror stack For L3PortMirrorSession configured mirror stack, show the TN node friendly name which spaned in L3PortMirrorSession.	string	Required
vmknic_status	Mirror vmknic status Show the vmknic health status, if the vmknic has been bouned to mirror stack, it will show SUCCESS or it will show FAILED.	MirrorStackStatusType	Required

Tooltip (schema)

Tooltip

Tooltip to be shown while hovering over the dashboard UI element.

Name	Description	Type	Notes
condition	Expression for evaluating condition If the condition is met then the tooltip will be applied. If no condition is provided, then the tooltip will be applied unconditionally. Examples of expression syntax are provided under 'example_request' section of 'CreateWidgetConfiguration' API.	string	Maximum length: 1024
heading	Tooltip will be treated as header. If true, displays tooltip text in bold	boolean
text	Textbox shown at tooltip Text to be shown on tooltip while hovering over UI element. The text would be wrapped if it exceeds 80 chars.	string	Required Maximum length: 1024

TraceflowConfig (schema)

Traceflow configuration

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
is_transient	Marker to indicate if intent is transient This field indicates if intent is transient and will be cleaned up by the system if set to true	boolean	Default: "True"
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
packet	Packet configuration Configuration of packet data	PacketData (Abstract type: pass one of the following concrete types) BinaryPacketData FieldsPacketData	Required
parent_path	Path of its parent Path of its parent	string	Readonly
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 TraceflowConfig	string
segment_port_path	Segment Port Path or UUID	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
timeout	Timeout for traceflow observation results Maximum time in seconds the management plane will wait for observation result to be sent by opsAgent.	integer	Minimum: 5 Maximum: 15 Default: "10"
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

TrafficRateLimits (schema)

Rate limiting configuration

Enables traffic limit for incoming/outgoing broadcast and multicast packets. Use 0 to disable rate limiting for a specific traffic type

Name	Description	Type	Notes
rx_broadcast	Broadcast receive limit Incoming broadcast traffic limit in packets per second	int	Minimum: 0 Default: "0"
rx_multicast	Multicast receive limit Incoming multicast traffic limit in packets per second	int	Minimum: 0 Default: "0"
tx_broadcast	Broadcast transmit limit Outgoing broadcast traffic limit in packets per second	int	Minimum: 0 Default: "0"
tx_multicast	Multicast transmit limit Outgoing multicast traffic limit in packets per second	int	Minimum: 0 Default: "0"

TransportInfo (schema)

Name	Description	Type	Notes
dst_port	Destination port	integer	Minimum: 0 Maximum: 65535
protocol	Protocol type over IP layer	string	Enum: TCP, UDP, ICMPv4, ICMPv6
src_port	Source port	integer	Minimum: 0 Maximum: 65535

TransportNodeIdParameters (schema)

Name	Description	Type	Notes
source	The data source, either realtime or cached. If not provided, cached data is returned.	DataSourceType
transport_node_id	TransportNode Id	string

TransportNodeSpanEnforcedStatus (schema)

Enforced Realized Status across Transport Nodes

Detailed Realized Status of an Intent on a span of Transport Nodes.

Name	Description	Type	Notes
enforced_status_per_transport_node	List of Enforced Realized Status per Transport Node List of Detailed Realized Status per Transport Node.	array of EnforcedStatusPerTransportNode	Readonly
resource_type	Must be set to the value TransportNodeSpanEnforcedStatus	string	Required Readonly Enum: TransportNodeSpanEnforcedStatus

TransportProtocolHeader (schema)

Name	Description	Type	Notes
dhcp_header	DHCP header	DhcpHeader
dhcpv6_header	DHCP v6 header	Dhcpv6Header
dns_header	DNS header	DnsHeader
icmp_echo_request_header	ICMP echo request header	IcmpEchoRequestHeader
ndp_header	Neighbor discovery protocol header	NdpHeader
tcp_header	TCP header	TcpHeader
udp_header	UDP header	UdpHeader

TunnelInterfaceIPSubnet (schema)

Name	Description	Type	Notes
ip_addresses	IPv4 Addresses	array of IPv4Address	Required Minimum items: 1 Maximum items: 1
prefix_length	Subnet Prefix Length	integer	Required Minimum: 1 Maximum: 31

TunnelSubnet (schema) (Deprecated)

Name	Description	Type	Notes
ip_addresses	Subnet ip addresses	array of IPv4Address	Required Minimum items: 1 Maximum items: 1
prefix_length	Subnet Prefix Length	integer	Required Minimum: 1 Maximum: 31

UcFunctionalState (schema)

Uc Functional State

Upgrade coordinator Uc functional State.

Name	Description	Type	Notes
error_message	error message error message that explains why UC is on standby mode.	string	Readonly
state	State of UC UI function state of the upgrade coordinator	string	Required Readonly Enum: RUNNING, STANDBY

UcStateProperties (schema)

Upgrade Coordinator state properties

Name	Description	Type	Notes
update_uc_state_properties	Flag for updating upgrade-coodinator state properties to database	boolean	Default: "True"

UcUpgradeStatus (schema)

UC Upgrade status

Upgrade status of upgrade-coordinator

Name	Description	Type	Notes
state	State of UC upgrade Current state of UC upgrade	string	Readonly Enum: NOT_STARTED, IN_PROGRESS, SUCCESS, FAILED
status	Status of UC upgrade Status of UC upgrade	string	Readonly

UdpHeader (schema)

Name	Description	Type	Notes
dst_port	Destination port of udp header	integer	Minimum: 0 Maximum: 65535 Default: "0"
src_port	Source port of udp header	integer	Minimum: 0 Maximum: 65535 Default: "0"

UdpPolicyLbMonitorProfile (schema)

PolicyLbMonitorProfile for active health checks over UDP

Active healthchecks are disabled by default and can be enabled for a
server pool by binding a health monitor to the Group through the PolicyLbRule
object. This represents active health monitoring over UDP. Active
healthchecks are initiated periodically, at a configurable interval, to
each member of the Group. Only if a healthcheck fails consecutively for a
specified number of times (fall_count) to a member will the member status
be marked DOWN. Once a member is DOWN, a specified number of consecutive
successful healthchecks (rise_count) will bring the member back to UP
state. After a healthcheck is initiated, if it does not complete within a
certain period, then also the healthcheck is considered to be
unsuccessful. Completing a healthcheck within timeout means establishing
a connection (TCP or SSL), if applicable, sending the request and
receiving the response, all within the configured timeout.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
fall_count	Monitor fall count for active healthchecks Only if a healthcheck fails consecutively for a specified number of times, given with fall_count, to a member will the member status be marked DOWN.	integer	Default: "3"
id	Unique identifier of this resource	string	Sortable
interval	Monitor interval in seconds for active healthchecks Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group.	integer	Default: "5"
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
monitor_port	Monitor port for active healthchecks Typically, monitors perform healthchecks to Group members using the member IP address and pool_port. However, in some cases, customers prefer to run healthchecks against a different port than the pool member port which handles actual application traffic. In such cases, the port to run healthchecks against can be specified in the monitor_port value.	int	Minimum: 0 Maximum: 65535
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
receive	expected data received from server Expected data, can be anywhere in the response and it has to be a string, regular expressions are not supported. UDP healthcheck is considered failed if there is no server response within the timeout period.	string	Required
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value UdpPolicyLbMonitorProfile	string	Required Enum: TcpPolicyLbMonitorProfile, UdpPolicyLbMonitorProfile, IcmpPolicyLbMonitorProfile, HttpPolicyLbMonitorProfile, HttpsPolicyLbMonitorProfile
rise_count	Monitor rise count for active healthchecks Once a member is DOWN, a specified number of consecutive successful healthchecks specified by rise_count will bring the member back to UP state.	integer	Default: "3"
send	data to send The data to be sent to the monitored server.	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
timeout	Monitor timeout in seconds for active healthchecks Timeout specified in seconds. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.	integer	Default: "15"
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

UdpPolicyLbVirtualServer (schema)

PolicyLbVirtualServer handling connections over UDP

Virtual server acts as a facade to an application, receives all client
connections over UDP and distributes them among the backend servers.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
access_log_enabled	Access log enabled setting If access log is enabled, all HTTP requests sent to an L7 virtual server are logged to the access log file. Both successful requests (backend server returns 2xx) and unsuccessful requests (backend server returns 4xx or 5xx) are logged to access log, if enabled.	boolean	Default: "False"
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
ip_address	IP address of the PolicyLbVirtualServer Configures the IP address of the PolicyLbVirtualServer where it receives all client connections and distributes them among the backend servers.	IPAddress	Required
lb_persistence_profile	Persistence Profile used by PolicyLbVirtualServer Path to optional object that enables persistence on a virtual server allowing related client connections to be sent to the same backend server. Persistence is disabled by default.	string
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
ports	Virtual server port number(s) or port range(s) Ports contains a list of at least one port or port range such as "80", "1234-1236". Each port element in the list should be a single port or a single port range.	array of PortElement	Required
relative_path	Relative path of this object Path relative from its parent	string	Readonly
resource_type	Must be set to the value UdpPolicyLbVirtualServer	string	Required Enum: TcpPolicyLbVirtualServer, UdpPolicyLbVirtualServer, HttpPolicyLbVirtualServer, HttpsPolicyLbVirtualServer, CustomPolicyLbVirtualServer
router_path	Path to router type object for PolicyLbVirtualServer Path to router type object that PolicyLbVirtualServer connects to. The only supported router object is Network.	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
traffic_source		string
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

UnaryOperation (schema)

Unary Operation

Unary Operation.

Name	Description	Type	Notes
operand	Operand Represents an argument of the operation pointing to a specific field value.	ResourceFieldPointer	Required
operator	Operator Logical Operator describing the operation to apply to the operand.	string	Required Enum: APPEND, SUBTRACT

UnaryOperationBasedInjectionValue (schema)

Operation based Injection Value

Operation based Injection Value.

Name	Description	Type	Notes
initial_value	Intitial value Resource field pointer representing the initial value for the injection value. If an operation is supplied, the value is handed to the operation function to produce a final result.	ResourceFieldPointer	Required
operation	Operation Function Represents an optional operation to be done on the initial value.	UnaryOperation
resource_type	Must be set to the value UnaryOperationBasedInjectionValue	string	Required Enum: UnaryOperationBasedInjectionValue

UnboundedKeyValuePair (schema)

A key-value pair with no limitations on size

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

UnsupportedFeature (schema)

Unsupported features

List of unsupported features for configuration onboarding on global manager.

Name	Description	Type	Notes
UnsupportedFeature	Unsupported features List of unsupported features for configuration onboarding on global manager.	string	Enum: LB

UpgradeBundle (schema)

Name	Description	Type	Notes
file	Upgrade bundle file	multipart_file	Required

UpgradeBundleFetchRequest (schema)

Fetch request for fetching upgrade bundle

URL and other fetch requests of upgrade bundle

Name	Description	Type	Notes
url	URL of upgrade bundle URL for uploading upgrade bundle	string	Required

UpgradeBundleId (schema)

Bundle id of upgrade bundle

Identifier of the upgrade bundle

Name	Description	Type	Notes
bundle_id	Bundle Id of upgrade bundle uploaded Identifier of bundle upload	string	Readonly

UpgradeBundleInfo (schema)

Information about upgrade bundle

Information about the upgrade bundle

Name	Description	Type	Notes
bundle_size	size of upgrade bundle	string	Readonly
url	URL of the upgrade bundle URL for uploading upgrade bundle	string	Readonly

UpgradeBundleUploadStatus (schema)

Upload status of upgrade bundle

Upload status of upgrade bundle uploaded from url

Name	Description	Type	Notes
detailed_status	Detailed status of bundle upload Detailed status of upgrade bundle upload	string	Readonly
percent	Percent of upload completed Percent of bundle uploaded from URL	number	Readonly
status	Status of upgrade bundle upload Current status of upgrade bundle upload	string	Readonly Enum: UPLOADING, VERIFYING, SUCCESS, FAILED
url	URL from which the bundle was uploaded URL for uploading upgrade bundle	string	Readonly

UpgradeCheck (schema)

Pre/post-upgrade check

Check to identify potential pre/post-upgrade issues

Name	Description	Type	Notes
component_type	Component type	string	Required
display_name	Name of the pre/post-upgrade check	string
failure_messages	List of failure messages List of failure messages. This field is deprecated now. Please use failures instead.	array of string	Deprecated Readonly
failures	List of failures	array of UpgradeCheckFailureMessage	Readonly
status	Status of pre/post-upgrade check	string	Required Readonly Enum: SUCCESS, FAILURE, WARNING

UpgradeCheckCsvListResult (schema)

Name	Description	Type	Notes
file_name	File name File name set by HTTP server if API returns CSV result as a file.	string
results		array of UpgradeCheckCsvRecord

UpgradeCheckCsvRecord (schema)

CSV record for an upgrade-check

CSV record for a pre/post-upgrade check

Name	Description	Type	Notes
check_description	Description of the upgrade check Description of the pre/post-upgrade check	string
check_name	Name of the upgrade check Display name of the pre/post-upgrade check	string	Required
failure_messages	Failure messages Space-separated list of failure messages	string	Readonly
status	Status of the upgrade check Status of the pre/post-upgrade check	string	Required Readonly Enum: SUCCESS, FAILURE, WARNING
upgrade_unit_id	UUID of the upgrade unit Identifier of the upgrade unit	string	Required Readonly
upgrade_unit_metadata	Meta-data of the upgrade-unit Meta-data of the upgrade-unit	string	Readonly
upgrade_unit_type	Component type Component type of the upgrade unit	string	Required

UpgradeCheckFailure (schema)

Upgrade check failure

Pre/post-upgrade check failure

Name	Description	Type	Notes
component_type	Component type Component type of the origin of failure	string	Required Readonly
group_name	Name of upgrade group Name of the upgrade group of the origin of failure. Only applicable when origin_type is UPGRADE_UNIT.	string
message	Upgrade check failure message Pre/post-upgrade check failure message	UpgradeCheckFailureMessage	Required Readonly
origin_id	Unique id of origin of failure Unique id of origin of pre/post-upgrade check failure	string	Required Readonly
origin_name	Name of origin of failure Name of origin of pre/post-upgrade check failure	string	Required Readonly
origin_type	Type of origin of failure Type of origin of pre/post-upgrade check failure	string	Required Readonly Enum: COMPONENT, UPGRADE_UNIT
type	Type of failure Type of the pre/post-upgrade check failure	string	Required Readonly Enum: FAILURE, WARNING

UpgradeCheckFailureListRequestParameters (schema)

Name	Description	Type	Notes
component_type	Component type Component type on which upgrade check failures are to be filtered	string
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
filter_text	Filter text Text to filter the results on. The filter text is matched with origin name and failure message. String matching for the filter is case-insensitive.	string
included_fields	Comma separated list of fields that should be included in query result	string
origin_type	Type of origin of failure Type of origin of pre/post-upgrade check failure	string	Enum: COMPONENT, UPGRADE_UNIT
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string
type	Status of the upgrade check Status of the pre/post-upgrade check to filter the results on	string	Enum: FAILURE, WARNING

UpgradeCheckFailureListResult (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Collection of pre/post-upgrade check failures	array of UpgradeCheckFailure	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

UpgradeCheckFailureMessage (schema)

Upgrade check failure message

Pre/post-upgrade check failure message

Name	Description	Type	Notes
error_code	Error code Error code for the error/warning	integer	Required Readonly
message	Error/warning message Error/warning message	string	Required Readonly

UpgradeCheckInfo (schema)

Meta-data of a pre/post-upgrade check

Meta-data of a pre/post-upgrade check

Name	Description	Type	Notes
component_type	Component type Component type of the pre/post-upgrade check	string	Required
description	Description Description of the pre/post-upgrade check	string	Readonly
name	Name of the upgrade check Display name of the pre/post-upgrade check	string	Required Readonly

UpgradeCheckInfoListRequestParameters (schema)

Name	Description	Type	Notes
component_type	Component type based on which upgrade checks are to be filtered	string
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

UpgradeCheckListResult (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
checks	Paged Collection of pre/post-upgrade checks	array of UpgradeCheck	Required
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

UpgradeCheckListResults (schema)

Name	Description	Type	Notes
checks_with_warnings		UpgradeCheckListResult	Readonly
failed_checks		UpgradeCheckListResult	Readonly
successful_checks		UpgradeCheckListResult	Readonly

UpgradeChecksExecutionStatus (schema)

Execution status of pre/post-upgrade checks

Execution status of pre/post-upgrade checks

Name	Description	Type	Notes
details	Details about current execution of pre/post-upgrade checks	string	Readonly
end_time	Time (in milliseconds since epoch) when the execution of pre/post-upgrade checks completed	EpochMsTimestamp
failure_count	Failure count Total count of generated failures or warnings in last execution of pre/post-upgrade checks	int	Readonly
node_with_issues_count	Number of nodes with failures/warnings Number of nodes which generated failures or warnings in last execution of pre/post-upgrade checks	int	Readonly
start_time	Time (in milliseconds since epoch) when the execution of pre/post-upgrade checks started	EpochMsTimestamp
status	Status of execution of pre/post-upgrade checks	string	Required Readonly Enum: NOT_STARTED, IN_PROGRESS, ABORTING, ABORTED, COMPLETED

UpgradeHistory (schema)

Name	Description	Type	Notes
initial_version	Initial Version Version before the upgrade started	string	Required
target_version	Target Version Version being upgraded to	string	Required
timestamp	Timestamp (in milliseconds since epoch) when the upgrade was performed	EpochMsTimestamp	Required
upgrade_status	Status of the upgrade	string	Required Enum: STARTED, SUCCESS, FAILED

UpgradeHistoryList (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Upgrade history list	array of UpgradeHistory	Readonly
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

UpgradePlanResetRequest (schema)

Name	Description	Type	Notes
component_type	Component type	string	Required

UpgradePlanSettings (schema)

Name	Description	Type	Notes
parallel	Upgrade Method to specify whether the upgrade is to be performed serially or in parallel	boolean	Default: "True"
pause_after_each_group	Flag to indicate whether to pause the upgrade after upgrade of each group is completed	boolean	Default: "False"
pause_on_error	Flag to indicate whether to pause the upgrade plan execution when an error occurs	boolean	Default: "False"

UpgradeProgressStatus (schema)

Upgrade progress status

Name	Description	Type	Notes
last_upgrade_step_status	Status of last upgrade step	object
upgrade_bundle_present	True if upgrade bundle is present	boolean
upgrade_metadata	Meta info of upgrade	object

UpgradeStatus (schema)

Name	Description	Type	Notes
ccp_status	CCP upgrade status	CCPUpgradeStatus	Readonly
component_status	List of component statuses	array of ComponentUpgradeStatus	Required Readonly
edge_status	Edge upgrade status	EdgeUpgradeStatus	Readonly
host_status	Host upgrade status	HostUpgradeStatus	Readonly
overall_upgrade_status	Status of upgrade	string	Required Readonly Enum: SUCCESS, FAILED, IN_PROGRESS, NOT_STARTED, PAUSING, PAUSED

UpgradeStatusSummary (schema)

Upgrade status summry

Name	Description	Type	Notes
upgrade_bundle_present	True if upgrade bundle is present	boolean
upgrade_metadata	Meta info of upgrade	object
upgrade_steps	List of all upgrade steps performed	array of object

UpgradeSummary (schema)

Name	Description	Type	Notes
component_target_versions		array of ComponentTargetVersion	Readonly
system_version	Current system version	string	Required Readonly
target_version	Target system version	string	Required Readonly
upgrade_bundle_file_name	Name of the last successfully uploaded upgrade bundle file	string	Readonly
upgrade_coordinator_updated	Has upgrade coordinator been updated after upload of upgrade bundle file	boolean	Readonly
upgrade_coordinator_version	Current version of upgrade coordinator	string	Required Readonly
upgrade_status	Status of upgrade	string	Required Readonly Enum: SUCCESS, FAILED, IN_PROGRESS, NOT_STARTED, PAUSING, PAUSED

UpgradeTaskProperties (schema)

Task properties

Name	Description	Type	Notes
bundle_name	Name of Bundle	string	Required
parameters	Bundle arguments	object	Readonly
step	Step name	string

UpgradeTaskStatusQueryParameters (schema)

Name	Description	Type	Notes
bundle_name	Bundle Name Provide a bundle name	string	Pattern: "^[a-zA-Z0-9-.]+$"
upgrade_task_id	Upgrade Task ID Provide a task id	string	Pattern: "^[a-z0-9-]+$"

UpgradeUnit (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
current_version	Current version of upgrade unit This is component version e.g. if upgrade unit is of type edge, then this is edge version.	string	Readonly
display_name	Name of the upgrade unit	string
group	Info of the group to which this upgrade unit belongs	UpgradeUnitGroupInfo	Readonly
id	UUID of the upgrade unit Identifier of the upgrade unit	string	Required Readonly
metadata	Metadata about upgrade unit	array of KeyValuePair	Readonly
type	Upgrade unit type	string
warnings	List of warnings indicating issues with the upgrade unit that may result in upgrade failure	array of string	Readonly

UpgradeUnitAggregateInfo (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
current_version	Current version of upgrade unit This is component version e.g. if upgrade unit is of type edge, then this is edge version.	string	Readonly
display_name	Name of the upgrade unit	string
errors	List of errors occurred during upgrade of this upgrade unit	array of string	Readonly
group	Info of the group to which this upgrade unit belongs	UpgradeUnitGroupInfo	Readonly
id	Identifier of the upgrade unit Identifier of the upgrade unit	string	Required Readonly
metadata	Metadata about upgrade unit	array of KeyValuePair	Readonly
percent_complete	Indicator of upgrade progress in percentage	number	Required Readonly
post_upgrade_checks		UpgradeCheckListResults	Readonly
pre_upgrade_checks		UpgradeCheckListResults	Readonly
status	Status of upgrade unit	string	Required Readonly Enum: SUCCESS, FAILED, IN_PROGRESS, NOT_STARTED, PAUSING, PAUSED
type	Upgrade unit type	string
warnings	List of warnings indicating issues with the upgrade unit that may result in upgrade failure	array of string	Readonly

UpgradeUnitAggregateInfoListRequestParameters (schema)

Name	Description	Type	Notes
component_type	Component type based on which upgrade units to be filtered	string
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
group_id	Identifier of group based on which upgrade units to be filtered	string
has_errors	Flag to indicate whether to return only upgrade units with errors	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
metadata	Metadata about upgrade unit to filter on	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
selection_status	Flag to indicate whether to return only selected, only deselected or both type of upgrade units	string	Enum: SELECTED, DESELECTED, ALL Default: "ALL"
sort_ascending		boolean
sort_by	Field by which records are sorted	string
upgrade_unit_display_name	Display name of upgrade unit Display name of upgrade unit to filter the results on. String matching for the filter is case-insensitive.	string

UpgradeUnitAggregateInfoListResult (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Paged collection of UpgradeUnit AggregateInfo	array of UpgradeUnitAggregateInfo	Required Readonly
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

UpgradeUnitGroup (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
enabled	Flag to indicate whether upgrade of this group is enabled or not	boolean	Default: "True"
extended_configuration	Extended configuration for the group	array of KeyValuePair	Maximum items: 100
id	Unique identifier of this resource	string	Sortable
parallel	Upgrade method to specify whether the upgrade is to be performed in parallel or serially	boolean	Default: "True"
resource_type	Must be set to the value UpgradeUnitGroup	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
type	Component type	string	Required
upgrade_unit_count	Count of upgrade units in the group Number of upgrade units in the group	int	Readonly
upgrade_units	List of upgrade units in the group	array of UpgradeUnit	Maximum items: 100

UpgradeUnitGroupAggregateInfo (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
enabled	Flag to indicate whether upgrade of this group is enabled or not	boolean	Default: "True"
extended_configuration	Extended configuration for the group	array of KeyValuePair	Maximum items: 100
failed_count	Number of nodes in the upgrade unit group that failed upgrade	int	Readonly
group_level_failure	Reports failures that occured at the group or cluster level.	array of string	Readonly
id	Unique identifier of this resource	string	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
post_upgrade_status	Post-upgrade status of group	UpgradeChecksExecutionStatus	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, PAUSING, PAUSED
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
type	Component type	string	Required
upgrade_unit_count	Count of upgrade units in the group Number of upgrade units in the group	int	Readonly
upgrade_units	List of upgrade units in the group	array of UpgradeUnit	Maximum items: 100

UpgradeUnitGroupAggregateInfoListResult (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Paged collection of upgrade status for upgrade unit groups	array of UpgradeUnitGroupAggregateInfo	Required Readonly
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

UpgradeUnitGroupInfo (schema)

Name	Description	Type	Notes
display_name	Name of the group	string	Required Readonly
id	UUID of group Identifier of group	string	Required Readonly

UpgradeUnitGroupListRequestParameters (schema)

Name	Description	Type	Notes
component_type	Component type based on which upgrade unit groups to be filtered	string
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string
summary	Flag indicating whether to return summary	boolean	Default: "False"
sync	Synchronize before returning upgrade unit groups If true, synchronize with the management plane before returning upgrade unit groups	boolean	Default: "False"

UpgradeUnitGroupListResult (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Paged Collection of Upgrade unit groups	array of UpgradeUnitGroup	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

UpgradeUnitGroupStatus (schema)

Name	Description	Type	Notes
failed_count	Number of nodes in the upgrade unit group that failed upgrade	int	Readonly
group_id	UUID of upgrade unit group Identifier for upgrade unit group	string	Required Readonly
group_name	Upgrade unit group Name Name of the upgrade unit group	string	Required Readonly
percent_complete	Indicator of upgrade progress in percentage	number	Required Readonly
status	Upgrade status of upgrade unit group	string	Required Readonly Enum: SUCCESS, FAILED, IN_PROGRESS, NOT_STARTED, PAUSING, PAUSED
upgrade_unit_count	Number of upgrade units in the group	int	Required Readonly

UpgradeUnitGroupStatusListResult (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Paged collection of upgrade status for upgrade unit groups	array of UpgradeUnitGroupStatus	Required Readonly
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

UpgradeUnitList (schema)

Name	Description	Type	Notes
list	Collection of Upgrade units	array of UpgradeUnit	Required

UpgradeUnitListRequestParameters (schema)

Name	Description	Type	Notes
component_type	Component type based on which upgrade units to be filtered	string
current_version	Current version of upgrade unit based on which upgrade units to be filtered	string
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
group_id	UUID of group based on which upgrade units to be filtered	string
has_warnings	Flag to indicate whether to return only upgrade units with warnings	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
metadata	Metadata about upgrade unit to filter on	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string
upgrade_unit_type	Upgrade unit type based on which upgrade units to be filtered	string

UpgradeUnitListResult (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Paged Collection of Upgrade units	array of UpgradeUnit	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

UpgradeUnitStatus (schema)

Name	Description	Type	Notes
display_name	Name of upgrade unit	string	Required Readonly
errors	List of errors occurred during upgrade of this upgrade unit	array of string	Readonly
id	UUID of upgrade unit Identifier of upgrade unit	string	Required Readonly
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, PAUSING, PAUSED

UpgradeUnitStatusListResult (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Paged Collection of upgrade units status	array of UpgradeUnitStatus	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

UpgradeUnitTypeStats (schema)

Name	Description	Type	Notes
node_count	Number of nodes	int	Required Readonly
node_with_issues_count	Number of nodes with issues that may cause upgrade failure	int	Readonly
type	Type of upgrade unit	string	Required Readonly
version	Version of the upgrade unit	string	Required Readonly

UpgradeUnitTypeStatsList (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	List of upgrade unit type stats	array of UpgradeUnitTypeStats	Readonly
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

UpgradeUnitsStatsRequestParameters (schema)

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string
sync	Synchronize before returning upgrade unit stats If true, synchronize with the management plane before returning upgrade unit stats	boolean	Default: "False"

UrlAlias (schema)

Url Alias

Short name or alias of a url. It is used to represent the url.

Name	Description	Type	Notes
alias	Url Alias Name Short name or alias of url, if any. If not specified, the url can be referenced by its index in the array of urls of the datasource instance as $ (for example, $0).	string	Maximum length: 255
query	Search query of the search api, if any Search query to be applied, if any. If query string is not provided, it will be ignored.	string	Maximum length: 1024
url	Url Url to fetch data from.	string	Required Maximum length: 1024

UserInfo (schema)

Authenticated User Info

Name	Description	Type	Notes
roles	Permissions	array of NsxRole	Required Readonly
user_name	User Name	string	Required Readonly

VIFGroupAssociationRequestParams (schema)

List request parameters containing virtual network interface external ID and enforcement point path

List request parameters containing virtual network interface external ID and enforcement point path

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
enforcement_point_path	String Path of the enforcement point The path of the enforcement point from which the list of groups needs to be fetched. Forward slashes must be escaped using %2F. If no enforcement point path is specified, the default enforcement point is considered	string
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string
vif_external_id	Virtual network interface external ID	string	Required

VMGroupAssociationRequestParams (schema)

List request parameters containing virtual machine external ID and enforcement point path

List request parameters containing virtual machine external ID and enforcement point path

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
enforcement_point_path	String Path of the enforcement point The path of the enforcement point from which the list of groups needs to be fetched. Forward slashes must be escaped using %2F. If no enforcement point path is specified, the default enforcement point is considered	string
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string
vm_external_id	Virtual machine external ID	string	Required

ValueConstraintExpression (schema)

Represents the leaf level value constraint.

Represents the leaf level value constraint to constrain specified attribute
value to the set of values to be allowed/not-allowed.
Example - sourceGroups allowed to have only with list of groups.
{
"operator":"INCLUDES",
"values":["/infra/services/HTTP", "/infra/services/HTTPS"]
}

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
operator	Operation to check for value list for resource attribute of constraint.	string	Required Enum: INCLUDES, EXCLUDES, EQUALS
resource_type	Must be set to the value ValueConstraintExpression	string	Required Enum: ValueConstraintExpression, RelatedAttributeConditionalExpression, EntityInstanceCountConstraintExpression, FieldSanityConstraintExpression
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
values	Array of values to perform operation. List of values.	array of string	Required

VersionList (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
acceptable_versions	List of component versions	array of string	Required
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
resource_type	Must be set to the value VersionList	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

VidmInfo (schema)

Vidm Info

Name	Description	Type	Notes
display_name	User's Full Name Or User Group's Display Name	string	Required Readonly
name	Username Or Groupname	string	Required Readonly
type	Type	string	Required Readonly Enum: remote_user, remote_group

VidmInfoListResult (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	List results	array of VidmInfo	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

VidmInfoSearchRequestParameters (schema)

Vidm information search request parameters

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
search_string	Search string to search for. This is a substring search that is case insensitive.	string	Required
sort_ascending		boolean
sort_by	Field by which records are sorted	string

View (schema)

Dashboard View

Describes the configuration of a view to be displayed on the dashboard.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Widget Title Title of the widget.	string	Required Maximum length: 255
exclude_roles	Roles to which the shared view is not visible Comma separated list of roles to which the shared view is not visible. Allows user to prevent the visibility of a shared view to the specified roles. User defined roles can also be specified in the list. The roles can be obtained via GET /api/v1/aaa/roles. Please visit API documentation for details about roles. If include_roles is specified then exclude_roles cannot be specified.	string	Maximum length: 1024
id	Unique identifier of this resource	string	Sortable
include_roles	Roles to which the shared view is visible Comma separated list of roles to which the shared view is visible. Allows user to specify the visibility of a shared view to the specified roles. User defined roles can also be specified in the list. The roles can be obtained via GET /api/v1/aaa/roles. Please visit API documentation for details about roles.	string	Maximum length: 1024
resource_type	Must be set to the value View	string
shared	Share the view with other users Defaults to false. Set to true to publish the view to other users. The widgets of a shared view are visible to other users.	boolean	Default: "False"
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
weight	Weightage or placement of the view Determines placement of view relative to other views. The lower the weight, the higher it is in the placement order.	int	Default: "10000"
widgets	Widgets Array of widgets that are part of the view.	array of WidgetItem	Required Minimum items: 0

ViewList (schema)

List of Views

Represents a list of views.

Name	Description	Type	Notes
views	Array of views Array of views	array of View	Required Readonly

ViewQueryParameters (schema)

Parameters for querying views

Name	Description	Type	Notes
tag	The tag for which associated views to be queried. The tag for which associated views to be queried. For tags specified on views, scope is automatically set to 'nsx-dashboard' and hence scope is ignored for searching views based on tag.	string	Readonly
view_ids	Ids of the Views Comma separated ids of views to be queried.	string	Readonly Maximum length: 8192
widget_id	Id of widget configuration Id of widget to be queried for all the views it is part of.	string	Readonly Maximum length: 255

VirtualEndpoint (schema)

This endpoint is strictly of the type Virtual

A VirtualEndpoint represents an IP (or nexthop) which is outside
SDDC. It represents a redirection target for RedirectionPolicy.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 VirtualEndpoint	string	Required Enum: VirtualEndpoint, ServiceInstanceEndpoint
service_names	Services for which this endpoint to be created One VirtualEndpoint will be created per service name.	array of string	Required Minimum items: 1 Maximum items: 1
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
target_ips	IP addresses to redirect the traffic to IPs where either inbound or outbound traffic is to be redirected.	array of IPInfo	Required Minimum items: 1 Maximum items: 1
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

VirtualMachine (schema)

Name	Description	Type	Notes
_last_sync_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
compute_ids	List of external compute ids of the virtual machine in the format 'id-type-key:value' , list of external compute ids ['uuid:xxxx-xxxx-xxxx-xxxx', 'moIdOnHost:moref-11', 'instanceUuid:xxxx-xxxx-xxxx-xxxx']	array of string	Required
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
external_id	Current external id of this virtual machine in the system.	string	Required
guest_info	Guest virtual machine details Guest virtual machine details include OS name, computer name of guest VM. Currently this is supported for guests on ESXi that have VMware Tools installed.	GuestInfo
host_id	Id of the host in which this virtual machine exists.	string
local_id_on_host	Id of the vm unique within the host.	string	Required
power_state	Current power state of this virtual machine in the system.	string	Required Enum: VM_RUNNING, VM_STOPPED, VM_SUSPENDED, UNKNOWN
resource_type	Must be set to the value VirtualMachine	string	Required
source	Reference of the Host or Public Cloud Gateway that reported the VM	ResourceReference
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
type	Virtual Machine type; Edge, Service VM or other.	string	Required Readonly Enum: EDGE, SERVICE, REGULAR

VirtualNetworkInterface (schema)

Name	Description	Type	Notes
_last_sync_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
device_key	Device key of the virtual network interface.	string	Required
device_name	Device name of the virtual network interface.	string
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
external_id	External Id of the virtual network inferface.	string	Required
host_id	Id of the host on which the vm exists.	string	Required
ip_address_info	IP Addresses of the the virtual network interface, from various sources.	array of IpAddressInfo
lport_attachment_id	LPort Attachment Id of the virtual network interface.	string
mac_address	MAC address of the virtual network interface.	string	Required
owner_vm_id	Id of the vm to which this virtual network interface belongs.	string	Required
owner_vm_type	Owner virtual machine type; Edge, Service VM or other.	string	Readonly Enum: EDGE, SERVICE, REGULAR
resource_type	Must be set to the value VirtualNetworkInterface	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
vm_local_id_on_host	Id of the vm unique within the host.	string	Required

VirtualNetworkInterfaceListResult (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	VirtualNetworkInterface list results	array of VirtualNetworkInterface	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

VirtualPortgroup (schema)

Virtual portgroup on a virtual switch

Name	Description	Type	Notes
_last_sync_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cm_local_id	Id of the portgroup in compute manager Id of the portgroup, eg. a mo-ref from VC.	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
external_id	External id of the virtual portgroup	string	Required Readonly
origin_type	Portgroup type like DistributedVirtualPortgroup	string	Readonly
resource_type	Must be set to the value VirtualPortgroup	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

VirtualSwitch (schema)

Virtual switch on a compute manager

Name	Description	Type	Notes
_last_sync_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cm_local_id	ID of the virtual switch in compute manager	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
external_id	External id of the virtual switch	string	Required Readonly
origin_id	ID of the compute manager ID of the compute manager where this virtual switch is discovered.	string	Readonly
origin_type	Switch type like VmwareDistributedVirtualSwitch	string	Readonly
resource_type	Must be set to the value VirtualSwitch	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

VlanID (schema)

Virtual Local Area Network Identifier

Name	Description	Type	Notes
VlanID	Virtual Local Area Network Identifier	integer	Minimum: 0 Maximum: 4094

VlanVniRangePair (schema)

Vlan Vni pair resource

Vlan-Vni mapping pair resource in EvpnTenantConfig for ROUTE-SERVER Evpn mode

Name	Description	Type	Notes
vlans	List of VLAN ids List of VLAN ids and VLAN ranges (specified with '-').	string	Required
vnis	List of VNI ids List of VNI ids and VNI ranges (specified with '-'). The vni id is used for VXLAN transmission for a given tenant Vlan ID in ROUTE-SERVER Evpn.	string	Required

VmToolsInfo (schema)

Name	Description	Type	Notes
_last_sync_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
external_id	VM external ID Current external id of this virtual machine in the system.	string	Readonly
file_agent_version	File agent version on the VM Version of file agent on the VM of a third party partner solution.	string	Readonly
host_local_id	VM ID given by the host Id of the VM which is assigned locally by the host. It is the VM-moref on ESXi hosts, in other environments it is VM UUID.	string	Readonly
network_agent_version	Network agent version on the VM Version of network agent on the VM of a third party partner solution.	string	Readonly
resource_type	Must be set to the value VmToolsInfo	string	Required
source	Reference of the Host or Public Cloud Gateway that reported the VM.	ResourceReference	Readonly
svm_connectivity	Endpoint Protection status on the VM Endpoint Protection (Third party AV partner using NXGI) status on the VM. TRUE - VM is configured and protected by EPP Service VM. FALSE - VM is either not configured for protection or VM is disconnected from EPP Service VM.	boolean	Readonly
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
tools_version	VM tools version on the VM Version of VMTools installed on the VM.	string	Readonly
vm_type	Virtual Machine type Type of VM - Edge, Service or other.	string	Readonly Enum: EDGE, SERVICE, REGULAR

VniPoolConfig (schema)

Vni Pool Config

Vni Pool Configuration.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
end	End value of VNI Pool range	int	Required Minimum: 75001 Maximum: 16777215
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
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 VniPoolConfig	string
start	Start value of VNI Pool range	int	Required Minimum: 75001 Maximum: 16777215
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

VrfEvpnL2VniConfig (schema)

Name	Description	Type	Notes
enable_vtep_groups	Flag to enable or disable the creation of vtep groups This is used to enable or disable the creation of vtep groups. Each vtep group is used to group vteps with the same MAC for L2 ECMP usage.	boolean	Default: "False"
l2_vni_configs	L2 VNI configurations associated with the VRF Define L2 VNI and its related route distinguiser and route targets.	array of VrfL2VniConfig	Required Minimum items: 1 Maximum items: 1

VrfL2VniConfig (schema)

Name	Description	Type	Notes
l2_vni	L2 VNI associated with the VRF L2 VNI associated with the VRF. It must be unique and available from the VNI pool defined for EVPN service.	int	Required
route_distinguisher	The unique route distinguisher for the virtual routing and forwarding instance This is a 64 bit number which disambiguates overlapping logical networks, with format in IPAddress: or ASN:.	string	Required
route_targets	Route targets Route targets.	array of VrfRouteTargets	Required Minimum items: 1 Maximum items: 1

VrfRouteTargets (schema)

Vrf Route Targets

Vrf Route Targets for import/export.

Name	Description	Type	Notes
address_family	Address family Address family.	string	Enum: L2VPN_EVPN Default: "L2VPN_EVPN"
export_route_targets	Export route targets Export route targets with format in ASN:.	array of string
import_route_targets	Import route targets Import route targets with format in ASN:.	array of string

VrniGlobalCollector (schema)

NSX global configs for VRNI global collector

Name	Description	Type	Notes
collector_ip	IP address for the global collector collector IP address for the global collector.	IPAddress	Required
collector_port	Port for the global collector Port for the global collector.	int	Required Minimum: 0 Maximum: 65535
collector_type	Must be set to the value VrniGlobalCollector	GlobalCollectorType	Required
report_interval	Report interval for operation data in seconds Report interval for operation data in seconds.	int	Required Minimum: 1 Maximum: 1800 Default: "30"

WaveFrontGlobalCollector (schema)

NSX global configs for WAVE_FRONT global collector

Name	Description	Type	Notes
collector_ip	IP address for the global collector collector IP address for the global collector.	IPAddress	Required
collector_port	Port for the global collector Port for the global collector.	int	Required Minimum: 0 Maximum: 65535
collector_type	Must be set to the value WaveFrontGlobalCollector	GlobalCollectorType	Required

WeeklyBackupSchedule (schema)

Schedule to specify day of the week and time to take automated backup

Name	Description	Type	Notes
days_of_week	Days of week when backup is taken. 0 - Sunday, 1 - Monday, 2 - Tuesday, 3 - Wednesday ...	array of integer	Required Minimum items: 1 Maximum items: 7
hour_of_day	Time of day when backup is taken	integer	Required Minimum: 0 Maximum: 23
minute_of_day	Time of day when backup is taken	integer	Required Minimum: 0 Maximum: 59
resource_type	Must be set to the value WeeklyBackupSchedule	string	Required Enum: WeeklyBackupSchedule, IntervalBackupSchedule

WidgetConfiguration (schema)

Dashboard Widget Configuration

Describes the configuration of a widget to be displayed on the dashboard. WidgetConfiguration is a base type that provides attributes of a widget in-general.

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
datasources	Array of Datasource Instances with their relative urls The 'datasources' represent the sources from which data will be fetched. Currently, only NSX-API is supported as a 'default' datasource. An example of specifying 'default' datasource along with the urls to fetch data from is given at 'example_request' section of 'CreateWidgetConfiguration' API.	array of Datasource	Minimum items: 0
default_filter_value	Default filter value to be passed to datasources Default filter values to be passed to datasources. This will be used when the report is requested without filter values.	array of DefaultFilterValue
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Widget Title Title of the widget. If display_name is omitted, the widget will be shown without a title.	string	Maximum length: 255
drilldown_id	Id of drilldown widget Id of drilldown widget, if any. Id should be a valid id of an existing widget. A widget is considered as drilldown widget when it is associated with any other widget and provides more detailed information about any data item from the parent widget.	string	Maximum length: 255
feature_set	Features required to view the widget Features required to view the widget.	FeatureSet
filter	Id of filter widget for subscription Id of filter widget for subscription, if any. Id should be a valid id of an existing filter widget. Filter widget should be from the same view. Datasource URLs should have placeholder values equal to filter alias to accept the filter value on filter change.	string
filter_value_required	Flag to indicate if filter value is necessary Flag to indicate that widget will continue to work without filter value. If this flag is set to false then default_filter_value is manadatory.	boolean	Default: "True"
footer		Footer
icons	Icons Icons to be applied at dashboard for widgets and UI elements.	array of Icon
id	Unique identifier of this resource	string	Sortable
is_drilldown	Set as a drilldown widget Set to true if this widget should be used as a drilldown.	boolean	Default: "False"
legend	Legend for the widget Legend to be displayed. If legend is not needed, do not include it.	Legend
resource_type	Must be set to the value WidgetConfiguration	string	Required Readonly Enum: LabelValueConfiguration, DonutConfiguration, MultiWidgetConfiguration, ContainerConfiguration, StatsConfiguration, GridConfiguration, GraphConfiguration, CustomWidgetConfiguration, DropdownFilterWidgetConfiguration Maximum length: 255
shared	Visiblity of widgets to other users Please use the property 'shared' of View instead of this. The widgets of a shared view are visible to other users.	boolean	Deprecated
span	Horizontal span Represents the horizontal span of the widget / container.	int	Minimum: 1 Maximum: 12
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
weight	Weightage or placement of the widget or container Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details.	int	Deprecated

WidgetConfigurationList (schema)

List of Widget Configurations

Represents a list of widget configurations.

Name	Description	Type	Notes
widgetconfigurations	Array of widget configurations Array of widget configurations	array of WidgetConfiguration (Abstract type: pass one of the following concrete types) ContainerConfiguration CustomWidgetConfiguration DonutConfiguration DropdownFilterWidgetConfiguration FilterWidgetConfiguration GraphConfiguration GridConfiguration LabelValueConfiguration MultiWidgetConfiguration StatsConfiguration WidgetConfiguration	Required Readonly

WidgetItem (schema)

Widget held by MultiWidgetConfiguration or Container or a View

Represents a reference to a widget that is held by a container or a multi-widget or a View.

Name	Description	Type	Notes
alignment	Alignment of widget inside container Aligns widget either left or right.	string	Enum: LEFT, RIGHT Default: "LEFT"
label	Label of the the report Applicable for 'DonutConfiguration' and 'StatsConfiguration' reports only. If label is not specified, then it defaults to the label of the donut or stats report.	Label
separator	A separator after this widget If true, separates this widget in a container.	boolean	Default: "False"
weight	Weightage or placement of the widget or container Determines placement of widget or container relative to other widgets and containers. The lower the weight, the higher it is in the placement order.	int	Default: "10000"
widget_id	Id of the widget configuration Id of the widget configuration that is held by a multi-widget or a container or a view.	string	Required Maximum length: 255

WidgetQueryParameters (schema)

Parameters for querying widget configurations

Name	Description	Type	Notes
container	Id of the container Id of the container whose widget configurations are to be queried.	string	Readonly Maximum length: 255
widget_ids	Ids of the WidgetConfigurations Comma separated ids of WidgetConfigurations to be queried.	string	Readonly Maximum length: 8192

X509Certificate (schema)

Name	Description	Type	Notes
dsa_public_key_g	One of the DSA cryptogaphic algorithm's strength parameters, base.	string	Readonly
dsa_public_key_p	One of the DSA cryptogaphic algorithm's strength parameters, prime.	string	Readonly
dsa_public_key_q	One of the DSA cryptogaphic algorithm's strength parameters, sub-prime.	string	Readonly
dsa_public_key_y	One of the DSA cryptogaphic algorithm's strength parameters.	string	Readonly
ecdsa_curve_name	ECDSA Curve Name The Curve name for the ECDSA certificate.	string	Readonly
ecdsa_ec_field	ECDSA Elliptic Curve Finite Field Represents an elliptic curve (EC) finite field in ECDSA.	string	Readonly Enum: F2M, FP
ecdsa_ec_field_f2mks	ECDSA Elliptic Curve F2MKS The order of the middle term(s) of the reduction polynomial in elliptic curve (EC) | characteristic 2 finite field.| Contents of this array are copied to protect against subsequent modification in ECDSA.	array of integer	Readonly
ecdsa_ec_field_f2mm	ECDSA Elliptic Curve F2MM The first coefficient of this elliptic curve in elliptic curve (EC) | characteristic 2 finite field for ECDSA.	integer	Readonly
ecdsa_ec_field_f2mrp	ECDSA Elliptic Curve F2MRP The value whose i-th bit corresponds to the i-th coefficient of the reduction polynomial | in elliptic curve (EC) characteristic 2 finite field for ECDSA.	string	Readonly
ecdsa_ec_field_f2pp	ECDSA Elliptic Curve F2PP The specified prime for the elliptic curve prime finite field in ECDSA.	string	Readonly
ecdsa_public_key_a	ECDSA Elliptic Curve Public Key A The first coefficient of this elliptic curve in ECDSA.	string	Readonly
ecdsa_public_key_b	ECDSA Elliptic Curve Public Key B The second coefficient of this elliptic curve in ECDSA.	string	Readonly
ecdsa_public_key_cofactor	ECDSA Elliptic Curve Public Key Cofactor The co-factor in ECDSA.	integer	Readonly
ecdsa_public_key_generator_x	ECDSA Elliptic Curve Public Key X X co-ordinate of G (the generator which is also known as the base point) in ECDSA.	string	Readonly
ecdsa_public_key_generator_y	ECDSA Elliptic Curve Public Key Y Y co-ordinate of G (the generator which is also known as the base point) in ECDSA.	string	Readonly
ecdsa_public_key_order	ECDSA Elliptic Curve Public Key Order The order of generator G in ECDSA.	string	Readonly
ecdsa_public_key_seed	ECDSA Elliptic Curve Public Key Seed The bytes used during curve generation for later validation in ECDSA.| Contents of this array are copied to protect against subsequent modification.	array of string	Readonly
is_ca	True if this is a CA certificate.	boolean	Required Readonly
is_valid	True if this certificate is valid.	boolean	Required Readonly
issuer	The certificate issuers complete distinguished name.	string	Required Readonly
issuer_cn	The certificate issuer's common name.	string	Required Readonly
not_after	The time in epoch milliseconds at which the certificate becomes invalid.	EpochMsTimestamp	Required Readonly
not_before	The time in epoch milliseconds at which the certificate becomes valid.	EpochMsTimestamp	Required Readonly
public_key_algo	Public Key Algorithm Cryptographic algorithm used by the public key for data encryption.	string	Required Readonly Enum: RSA, DSA, ECDSA
public_key_length	Size measured in bits of the public/private keys used in a cryptographic algorithm.	integer	Required Readonly
rsa_public_key_exponent	An RSA public key is made up of the modulus and the public exponent. Exponent is a power number.	string	Readonly
rsa_public_key_modulus	An RSA public key is made up of the modulus and the public exponent. Modulus is wrap around number.	string	Readonly
serial_number	Certificate's serial number.	string	Required Readonly
signature	The signature value(the raw signature bits) used for signing and validate the cert.	string	Required Readonly
signature_algorithm	The algorithm used by the Certificate Authority to sign the certificate.	string	Required Readonly
subject	The certificate owners complete distinguished name.	string	Required Readonly
subject_cn	The certificate owner's common name.	string	Required Readonly
version	Certificate version (default v1).	string	Required Readonly

X509Crl (schema)

A CRL is a time-stamped list identifying revoked certificates.

Name	Description	Type	Notes
crl_entries	List of X509CrlEntry.	array of X509CrlEntry	Readonly
issuer	Issuer's distinguished name. (DN)	string	Readonly
next_update	Next update time for the CRL.	string	Readonly
version	CRL's version number either 1 or 2.	string	Readonly

X509CrlEntry (schema)

Each revoked certificate is identified in a CRL by its certificate serial number.

Name	Description	Type	Notes
revocation_date	Revocation date.	string	Readonly
serial_number	The revoked certificate's serial number.	string	Readonly

API Type Schemas

ALGTypeServiceEntry (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ServiceEntry
  }, 
  "id": "ALGTypeServiceEntry", 
  "module_id": "Policy", 
  "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: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "alg": {
      "description": "The Application Layer Gateway (ALG) protocol. Please note, protocol NBNS_BROADCAST and NBDG_BROADCAST are  deprecated. Please use UDP protocol and create L4 Port Set type of service instead.", 
      "enum": [
        "ORACLE_TNS", 
        "FTP", 
        "SUN_RPC_TCP", 
        "SUN_RPC_UDP", 
        "MS_RPC_TCP", 
        "MS_RPC_UDP", 
        "NBNS_BROADCAST", 
        "NBDG_BROADCAST", 
        "TFTP"
      ], 
      "required": true, 
      "title": "The Application Layer Gateway (ALG) protocol", 
      "type": "string"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "destination_ports": {
      "items": {
        "$ref": "PortElement
      }, 
      "maxItems": 15, 
      "minItems": 1, 
      "required": true, 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": [
        "IPProtocolServiceEntry", 
        "IGMPTypeServiceEntry", 
        "ICMPTypeServiceEntry", 
        "ALGTypeServiceEntry", 
        "L4PortSetServiceEntry", 
        "EtherTypeServiceEntry", 
        "NestedServiceServiceEntry"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "source_ports": {
      "items": {
        "$ref": "PortElement
      }, 
      "maxItems": 15, 
      "required": false, 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "An ServiceEntry that represents an ALG protocol", 
  "type": "object"
}

AbstractSpace (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "description": "Represents the space in which the policy is being defined.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "AbstractSpace", 
  "module_id": "Policy", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "connectivity_strategy": {
      "deprecated": true, 
      "description": "The connectivity strategy is deprecated. Use default layer3 rule, /infra/domains/default/security-policies/default-layer3-security-policy/rules/default-layer3-rule. 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 WHITELIST_ENABLE_LOGGING - Whitelising with logging enabled BLACKLIST_ENABLE_LOGGING - Blacklisting with logging enabled NONE - No default rules are added.", 
      "enum": [
        "WHITELIST", 
        "BLACKLIST", 
        "WHITELIST_ENABLE_LOGGING", 
        "BLACKLIST_ENABLE_LOGGING", 
        "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "The space in which policy is being defined", 
  "type": "object"
}

AcceptableComponentVersion (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "VersionList
  }, 
  "id": "AcceptableComponentVersion", 
  "module_id": "VersionWhitelist", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "acceptable_versions": {
      "items": {
        "type": "string"
      }, 
      "required": true, 
      "title": "List of component versions", 
      "type": "array"
    }, 
    "component_type": {
      "enum": [
        "HOST", 
        "EDGE", 
        "CCP", 
        "MP"
      ], 
      "required": true, 
      "title": "Node type", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

AcceptableComponentVersionList (type)

{
  "additionalProperties": false, 
  "id": "AcceptableComponentVersionList", 
  "module_id": "VersionWhitelist", 
  "properties": {
    "results": {
      "items": {
        "$ref": "AcceptableComponentVersion
      }, 
      "required": true, 
      "title": "Acceptable version whitelist for different components", 
      "type": "array"
    }
  }, 
  "type": "object"
}

Action (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "description": "Reaction Action is the action to take when the stipulated criteria specified in the event exist over the source. Some example actions include: - Notify Admin (or VMC's SRE) via email. - Populate a specific label with the IPSec VPN Session. - Remove the IPSec VPN Session from a specific label.", 
  "id": "Action", 
  "module_id": "PolicyReaction", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "resource_type"
  }, 
  "properties": {
    "resource_type": {
      "description": "Reaction Action resource type.", 
      "enum": [
        "PatchResources", 
        "SetFields"
      ], 
      "required": true, 
      "title": "Resource Type", 
      "type": "string"
    }
  }, 
  "title": "Reaction Action", 
  "type": "object"
}

ActionableResource (type)

{
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "ActionableResource", 
  "module_id": "ClusterRestore", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ip_address": {
      "format": "hostname-or-ip", 
      "required": false, 
      "title": "A resource reference on which actions can be performed", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Resources managed during restore process", 
  "type": "object"
}

ActionableResourceListRequestParameters (type)

{
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "ActionableResourceListRequestParameters", 
  "module_id": "ClusterRestore", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "instruction_id": {
      "required": true, 
      "title": "Id of the instruction set whose instructions are to be returned", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ActionableResourceListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ActionableResourceListResult", 
  "module_id": "ClusterRestore", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "ActionableResource
      }, 
      "required": true, 
      "title": "List results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ActiveDirectoryIdentitySource (type)

{
  "description": "An identity source service that runs Microsoft Active Directory. The service allows selected user accounts defined in Active Directory to log into and access NSX-T.", 
  "extends": {
    "$ref": "LdapIdentitySource
  }, 
  "id": "ActiveDirectoryIdentitySource", 
  "module_id": "LdapIdentitySources", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ActiveDirectoryIdentitySource"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "alternative_domain_names": {
      "description": "After parsing the \"user@domain\", the domain portion is used to select the LDAP identity source to use. Additional domains listed here will also be directed to this LDAP identity source. In Active Directory these are sometimes referred to as Alternative UPN Suffixes.", 
      "items": {
        "type": "string"
      }, 
      "title": "Additional domains to be directed to this identity source", 
      "type": "array"
    }, 
    "base_dn": {
      "description": "The subtree of the LDAP identity source to search when locating users and groups.", 
      "required": true, 
      "title": "DN of subtree for user and group searches", 
      "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"
    }, 
    "domain_name": {
      "description": "The name of the authentication domain. When users log into NSX using an identity of the form \"user@domain\", NSX uses the domain portion to determine which LDAP identity source to use.", 
      "required": true, 
      "title": "Authentication domain name", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ldap_servers": {
      "description": "The list of LDAP servers that provide LDAP service for this identity source. Currently, only one LDAP server is supported.", 
      "items": {
        "$ref": "IdentitySourceLdapServer
      }, 
      "maxItems": 1, 
      "title": "LDAP servers for this identity source", 
      "type": "array"
    }, 
    "resource_type": {
      "enum": [
        "ActiveDirectoryIdentitySource", 
        "OpenLdapIdentitySource"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "An Active Directory identity source service", 
  "type": "object"
}

AddressBindingEntry (type)

{
  "additionalProperties": false, 
  "description": "An address binding entry is a combination of the IP-MAC-VLAN binding for a logical port. The address bindings can be obtained via various methods like ARP snooping, DHCP snooping etc. or by user configuration.", 
  "id": "AddressBindingEntry", 
  "module_id": "LogicalPort", 
  "properties": {
    "binding": {
      "$ref": "PacketAddressClassifier, 
      "title": "Combination of IP-MAC-VLAN binding"
    }, 
    "binding_timestamp": {
      "$ref": "EpochMsTimestamp, 
      "description": "Timestamp at which the binding was discovered via snooping or manually specified by the user", 
      "title": "Timestamp of binding"
    }, 
    "source": {
      "$ref": "AddressBindingSource, 
      "default": "UNKNOWN", 
      "description": "Source from which the address binding entry was obtained", 
      "title": "Address binding source"
    }
  }, 
  "title": "Combination of IP-MAC-VLAN binding", 
  "type": "object"
}

AddressBindingSource (type)

{
  "enum": [
    "INVALID", 
    "UNKNOWN", 
    "USER_DEFINED", 
    "ARP_SNOOPING", 
    "DHCP_SNOOPING", 
    "VM_TOOLS", 
    "ND_SNOOPING", 
    "DHCPV6_SNOOPING", 
    "VM_TOOLS_V6"
  ], 
  "id": "AddressBindingSource", 
  "module_id": "LogicalPort", 
  "title": "Source from which the address binding is obtained", 
  "type": "string"
}

AdvanceClusterRestoreInput (type)

{
  "id": "AdvanceClusterRestoreInput", 
  "module_id": "ClusterRestore", 
  "properties": {
    "id": {
      "readonly": true, 
      "required": true, 
      "title": "Unique id of an instruction (as returned by the GET /restore/status\ncall) for which input is to be provided\n", 
      "type": "string"
    }, 
    "resources": {
      "items": {
        "$ref": "SelectableResourceReference
      }, 
      "required": true, 
      "title": "List of resources for which the instruction is applicable.", 
      "type": "array"
    }
  }, 
  "type": "object"
}

AdvanceClusterRestoreRequest (type)

{
  "id": "AdvanceClusterRestoreRequest", 
  "module_id": "ClusterRestore", 
  "properties": {
    "data": {
      "items": {
        "$ref": "AdvanceClusterRestoreInput
      }, 
      "required": true, 
      "title": "List of instructions and their associated data", 
      "type": "array"
    }
  }, 
  "type": "object"
}

AggregateDNSForwarderStatistics (type)

{
  "additionalProperties": false, 
  "description": "Aggregate of DNS forwarder statistics across enforcement points.", 
  "id": "AggregateDNSForwarderStatistics", 
  "module_id": "PolicyDNSStatistics", 
  "properties": {
    "intent_path": {
      "description": "String path of the DNS forwarder intent.", 
      "required": true, 
      "title": "String path of the DNS forwarder intent", 
      "type": "string"
    }, 
    "statistics_per_enforcement_point": {
      "description": "List of DNS forwarder statistics per enforcement point.", 
      "items": {
        "$ref": "DNSForwarderStatisticsPerEnforcementPoint
      }, 
      "readonly": true, 
      "title": "List of DNS forwarder statistics per enforcement point", 
      "type": "array"
    }
  }, 
  "title": "Aggregate of DNS forwarder statistics", 
  "type": "object"
}

AggregateDNSForwarderStatus (type)

{
  "additionalProperties": false, 
  "description": "Aggregate of DNS forwarder status across enforcement points.", 
  "id": "AggregateDNSForwarderStatus", 
  "module_id": "PolicyDNSStatistics", 
  "properties": {
    "intent_path": {
      "description": "String path of the DNS forwarder intent.", 
      "required": true, 
      "title": "String path of the DNS forwarder intent", 
      "type": "string"
    }, 
    "status_per_enforcement_point": {
      "description": "List of DNS forwarder status per enforcement point.", 
      "items": {
        "$ref": "DNSForwarderStatusPerEnforcementPoint
      }, 
      "readonly": true, 
      "title": "List of DNS forwarder status per enforcement point", 
      "type": "array"
    }
  }, 
  "title": "Aggregate of DNS forwarder status", 
  "type": "object"
}

AggregatePolicyDnsAnswer (type)

{
  "additionalProperties": false, 
  "description": "Aggregate of DNS forwarder nslookup answer across enforcement points.", 
  "id": "AggregatePolicyDnsAnswer", 
  "module_id": "PolicyDnsForwarder", 
  "properties": {
    "dns_answer_per_enforcement_point": {
      "description": "List of DNS forwarder nslookup answer per enforcement point.", 
      "items": {
        "$ref": "PolicyDnsAnswerPerEnforcementPoint
      }, 
      "readonly": true, 
      "title": "List of DNS forwarder nslookup answer per enforcement point", 
      "type": "array"
    }, 
    "intent_path": {
      "description": "String path of the DNS forwarder intent.", 
      "required": true, 
      "title": "String path of the DNS forwarder intent", 
      "type": "string"
    }
  }, 
  "title": "Aggregate of DNS forwarder nslookup answer", 
  "type": "object"
}

AggregatePolicyRuntimeInfo (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "description": "Aggregate of PolicyRuntimeInfoPerEP across Enforcement Points.", 
  "id": "AggregatePolicyRuntimeInfo", 
  "module_id": "PolicyBaseStatistics", 
  "properties": {
    "intent_path": {
      "description": "Intent path of object, forward slashes must be escaped using %2F.", 
      "readonly": true, 
      "required": true, 
      "title": "String Path of the intent object", 
      "type": "string"
    }
  }, 
  "title": "Aggregate of PolicyRuntimeInfoPerEP", 
  "type": "object"
}

AggregatedDataCounter (type)

{
  "id": "AggregatedDataCounter", 
  "module_id": "AggSvcL2Types", 
  "properties": {
    "rx_bytes": {
      "$ref": "DataCounter, 
      "readonly": true, 
      "required": false
    }, 
    "rx_packets": {
      "$ref": "DataCounter, 
      "readonly": true, 
      "required": false
    }, 
    "tx_bytes": {
      "$ref": "DataCounter, 
      "readonly": true, 
      "required": false
    }, 
    "tx_packets": {
      "$ref": "DataCounter, 
      "readonly": true, 
      "required": false
    }
  }, 
  "type": "object"
}

AggregatedDataCounterEx (type)

{
  "extends": {
    "$ref": "AggregatedDataCounter
  }, 
  "id": "AggregatedDataCounterEx", 
  "module_id": "AggSvcL2Types", 
  "properties": {
    "dropped_by_security_packets": {
      "$ref": "PacketsDroppedBySecurity, 
      "readonly": true, 
      "required": false
    }, 
    "mac_learning": {
      "$ref": "MacLearningCounters, 
      "readonly": true, 
      "required": false
    }, 
    "rx_bytes": {
      "$ref": "DataCounter, 
      "readonly": true, 
      "required": false
    }, 
    "rx_packets": {
      "$ref": "DataCounter, 
      "readonly": true, 
      "required": false
    }, 
    "tx_bytes": {
      "$ref": "DataCounter, 
      "readonly": true, 
      "required": false
    }, 
    "tx_packets": {
      "$ref": "DataCounter, 
      "readonly": true, 
      "required": false
    }
  }, 
  "type": "object"
}

AggregatedLogicalRouterPortCounters (type)

{
  "id": "AggregatedLogicalRouterPortCounters", 
  "module_id": "AggSvcLogicalRouterPort", 
  "properties": {
    "last_update_timestamp": {
      "$ref": "EpochMsTimestamp, 
      "readonly": true, 
      "title": "Timestamp when the data was last updated; unset if data source has never updated the data."
    }, 
    "rx": {
      "$ref": "LogicalRouterPortCounters, 
      "readonly": true, 
      "required": false
    }, 
    "tx": {
      "$ref": "LogicalRouterPortCounters, 
      "readonly": true, 
      "required": false
    }
  }, 
  "type": "object"
}

ApiError (type)

{
  "extends": {
    "$ref": "RelatedApiError
  }, 
  "id": "ApiError", 
  "module_id": "Common", 
  "properties": {
    "details": {
      "title": "Further details about the error", 
      "type": "string"
    }, 
    "error_code": {
      "title": "A numeric error code", 
      "type": "integer"
    }, 
    "error_data": {
      "title": "Additional data about the error", 
      "type": "object"
    }, 
    "error_message": {
      "title": "A description of the error", 
      "type": "string"
    }, 
    "module_name": {
      "title": "The module name where the error occurred", 
      "type": "string"
    }, 
    "related_errors": {
      "items": {
        "$ref": "RelatedApiError
      }, 
      "title": "Other errors related to this error", 
      "type": "array"
    }
  }, 
  "title": "Detailed information about an API Error", 
  "type": "object"
}

ApiRequestBody (type)

{
  "additionalProperties": false, 
  "description": "API Request Body is an Event Source that represents an API request body that is being reveived as part of an API. Supported Request Bodies are those received as part of a PATCH/PUT/POST request.", 
  "extends": {
    "$ref": "Source
  }, 
  "id": "ApiRequestBody", 
  "module_id": "PolicyReaction", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ApiRequestBody"
  }, 
  "properties": {
    "resource_pointer": {
      "description": "Regex path representing a regex expression on resources. This regex is used to identify the request body(ies) that is/are the source of the Event. For instance: specifying \"Lb* | /infra/tier-0s/vmc/ipsec-vpn-services/default\" as a source means that ANY resource starting with Lb or ANY resource with \"/infra/tier-0s/vmc/ipsec-vpn-services/default\" as path would be the source of the event in question.", 
      "required": true, 
      "title": "Resource Pointer", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "Event Source resource type.", 
      "enum": [
        "ResourceOperation", 
        "ApiRequestBody"
      ], 
      "required": true, 
      "title": "Resource Type", 
      "type": "string"
    }
  }, 
  "title": "API Request Body", 
  "type": "object"
}

ApiServiceConfig (type)

{
  "additionalProperties": false, 
  "description": "Properties that affect the configuration of the NSX API service.", 
  "id": "ApiServiceConfig", 
  "properties": {
    "basic_authentication_enabled": {
      "default": true, 
      "description": "Identifies whether basic authentication is enabled or disabled in API calls.", 
      "title": "Enable or disable basic authentication", 
      "type": "boolean"
    }, 
    "cipher_suites": {
      "description": "The TLS cipher suites that the API service will negotiate.", 
      "items": {
        "$ref": "CipherSuite
      }, 
      "minItems": 1, 
      "title": "Cipher suites used to secure contents of connection", 
      "type": "array"
    }, 
    "client_api_concurrency_limit": {
      "default": 40, 
      "description": "The maximum number of concurrent API requests that will be serviced for a given authenticated client.  If the number of API requests being processed exceeds this limit, new API requests will be refused and a 503 Service Unavailable response will be returned to the client. To disable API concurrency limiting, set this value to 0.", 
      "minimum": 0, 
      "title": "Client API rate limit in calls", 
      "type": "integer"
    }, 
    "client_api_rate_limit": {
      "default": 100, 
      "description": "The maximum number of API requests that will be serviced per second for a given authenticated client.  If more API requests are received than can be serviced, a 429 Too Many Requests HTTP response will be returned. To disable API rate limiting, set this value to 0.", 
      "minimum": 0, 
      "title": "Client API rate limit in calls per second", 
      "type": "integer"
    }, 
    "connection_timeout": {
      "default": 30, 
      "description": "NSX connection timeout, in seconds. To disable timeout, set to 0.", 
      "maximum": 2147483647, 
      "minimum": 0, 
      "title": "NSX connection timeout", 
      "type": "integer"
    }, 
    "cookie_based_authentication_enabled": {
      "default": true, 
      "description": "Identifies whether cookie-based authentication is enabled or disabled in API calls. When cookie-based authentication is disabled, new sessions cannot be created via /api/session/create.", 
      "title": "Enable or disable cookie-based authentication", 
      "type": "boolean"
    }, 
    "global_api_concurrency_limit": {
      "default": 199, 
      "description": "The maximum number of concurrent API requests that will be serviced. If the number of API requests being processed exceeds this limit, new API requests will be refused and a 503 Service Unavailable response will be returned to the client.  To disable API concurrency limiting, set this value to 0.", 
      "minimum": 0, 
      "title": "Global API rate limit in calls", 
      "type": "integer"
    }, 
    "lockout_immune_addresses": {
      "description": "The list of IP addresses which are not subjected to a lockout on failed login attempts.", 
      "items": {
        "$ref": "IPAddress
      }, 
      "title": "IP addresses which are not subject to lockout on failed login attempts", 
      "type": "array"
    }, 
    "protocol_versions": {
      "description": "The TLS protocol versions that the API service will negotiate.", 
      "items": {
        "$ref": "ProtocolVersion
      }, 
      "minItems": 1, 
      "title": "TLS protocol versions", 
      "type": "array"
    }, 
    "redirect_host": {
      "$ref": "HostnameOrIPv4AddressOrEmptyString, 
      "default": "", 
      "description": "Host name or IP address to use for redirect location headers, or empty string to derive from current request. To disable, set redirect_host to the empty string (\"\").", 
      "title": "Hostname/IP to use in redirect headers"
    }, 
    "session_timeout": {
      "default": 1800, 
      "descriptions": "Sessions inactive for more than this value are terminated. The value is given in seconds. Set to 0 to disable timeouts.", 
      "maximum": 2147483647, 
      "minimum": 0, 
      "title": "NSX session inactivity timeout", 
      "type": "integer"
    }
  }, 
  "title": "Configuration of the API service", 
  "type": "object"
}

ApplianceManagementSuppressRedirectQueryParameter (type)

{
  "additionalProperties": false, 
  "id": "ApplianceManagementSuppressRedirectQueryParameter", 
  "properties": {
    "suppress_redirect": {
      "default": false, 
      "description": "Do not return a redirect HTTP status.", 
      "title": "Suppress redirect status if applicable", 
      "type": "boolean"
    }
  }, 
  "type": "object"
}

ApplianceManagementTaskListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ApplianceManagementTaskListResult", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "ApplianceManagementTaskProperties
      }, 
      "required": true, 
      "title": "Task property results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Appliance management task query results", 
  "type": "object"
}

ApplianceManagementTaskProperties (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "ApplianceManagementTaskProperties", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "async_response_available": {
      "readonly": true, 
      "title": "True if response for asynchronous request is available", 
      "type": "boolean"
    }, 
    "cancelable": {
      "readonly": true, 
      "title": "True if this task can be canceled", 
      "type": "boolean"
    }, 
    "description": {
      "readonly": true, 
      "title": "Description of the task", 
      "type": "string"
    }, 
    "details": {
      "readonly": true, 
      "title": "Details about the task if known", 
      "type": "object"
    }, 
    "end_time": {
      "$ref": "EpochMsTimestamp, 
      "readonly": true, 
      "title": "The end time of the task in epoch milliseconds"
    }, 
    "id": {
      "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}_[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$", 
      "readonly": true, 
      "title": "Identifier for this task", 
      "type": "string"
    }, 
    "message": {
      "readonly": true, 
      "title": "A message describing the disposition of the task", 
      "type": "string"
    }, 
    "progress": {
      "maximum": 100, 
      "minimum": 0, 
      "readonly": true, 
      "title": "Task progress if known, from 0 to 100", 
      "type": "integer"
    }, 
    "request_method": {
      "readonly": true, 
      "title": "HTTP request method", 
      "type": "string"
    }, 
    "request_uri": {
      "readonly": true, 
      "title": "URI of the method invocation that spawned this task", 
      "type": "string"
    }, 
    "start_time": {
      "$ref": "EpochMsTimestamp, 
      "readonly": true, 
      "title": "The start time of the task in epoch milliseconds"
    }, 
    "status": {
      "$ref": "ApplianceManagementTaskStatus, 
      "readonly": true, 
      "title": "Current status of the task"
    }, 
    "user": {
      "readonly": true, 
      "title": "Name of the user who created this task", 
      "type": "string"
    }
  }, 
  "title": "Appliance management task properties", 
  "type": "object"
}

ApplianceManagementTaskQueryParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResultQueryParameters
  }, 
  "id": "ApplianceManagementTaskQueryParameters", 
  "properties": {
    "fields": {
      "description": "Comma-separated field names to include in query result", 
      "title": "Fields to include in query results", 
      "type": "string"
    }, 
    "request_method": {
      "description": "Comma-separated request methods to include in query result", 
      "pattern": "^(=|!=|~|!~)?.+$", 
      "title": "Request method(s) to include in query result", 
      "type": "string"
    }, 
    "request_path": {
      "description": "Comma-separated request paths to include in query result", 
      "pattern": "^(=|!=|~|!~)?.+$", 
      "title": "Request URI path(s) to include in query result", 
      "type": "string"
    }, 
    "request_uri": {
      "description": "Comma-separated request URIs to include in query result", 
      "pattern": "^(=|!=|~|!~)?.+$", 
      "title": "Request URI(s) to include in query result", 
      "type": "string"
    }, 
    "status": {
      "description": "Comma-separated status values to include in query result", 
      "pattern": "^(=|!=|~|!~)?.+$", 
      "title": "Status(es) to include in query result", 
      "type": "string"
    }, 
    "user": {
      "description": "Comma-separated user names to include in query result", 
      "pattern": "^(=|!=|~|!~)?.+$", 
      "title": "Names of users to include in query result", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ApplianceManagementTaskStatus (type)

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

ApplicationConnectivityStrategy (type)

{
  "additionalProperties": false, 
  "description": "Allows more granular policies for application workloads", 
  "id": "ApplicationConnectivityStrategy", 
  "module_id": "Policy", 
  "properties": {
    "application_connectivity_strategy": {
      "description": "App connectivity strategies", 
      "enum": [
        "ALLOW_INTRA", 
        "ALLOW_EGRESS"
      ], 
      "required": true, 
      "title": "Application connectivity strategy", 
      "type": "string"
    }, 
    "default_application_rule_id": {
      "description": "Based on the value of the app connectivity strategy, a default rule is created for the security policy. The rule id is internally assigned by the system for this default rule.", 
      "readonly": true, 
      "required": false, 
      "title": "Default rule ID associated with the application_connectivity_strategy", 
      "type": "integer"
    }, 
    "logging_enabled": {
      "default": false, 
      "description": "Flag to enable packet logging. Default is disabled.", 
      "readonly": false, 
      "required": false, 
      "title": "Enable logging flag", 
      "type": "boolean"
    }
  }, 
  "title": "Application specific connectivity strategy", 
  "type": "object"
}

ArpHeader (type)

{
  "additionalProperties": false, 
  "id": "ArpHeader", 
  "module_id": "Traceflow", 
  "properties": {
    "dst_ip": {
      "$ref": "IPv4Address, 
      "required": true, 
      "title": "The destination IP address"
    }, 
    "op_code": {
      "default": "ARP_REQUEST", 
      "description": "This field specifies the nature of the Arp message being sent.", 
      "enum": [
        "ARP_REQUEST", 
        "ARP_REPLY"
      ], 
      "required": true, 
      "title": "Arp message type", 
      "type": "string"
    }, 
    "src_ip": {
      "$ref": "IPv4Address, 
      "description": "This field specifies the IP address of the sender. If omitted, the src_ip is set to 0.0.0.0.", 
      "required": false, 
      "title": "The source IP address"
    }
  }, 
  "type": "object"
}

ArpSnoopingConfig (type)

{
  "additionalProperties": false, 
  "description": "Contains ARP snooping related configuration.", 
  "id": "ArpSnoopingConfig", 
  "module_id": "PolicyIpDiscovery", 
  "properties": {
    "arp_binding_limit": {
      "default": 1, 
      "description": "Number of arp snooped IP addresses Indicates the number of arp snooped IP addresses to be remembered per LogicalPort. Decreasing this value, will retain the latest bindings from the existing list of address bindings. Increasing this value will retain existing bindings and also learn any new address bindings discovered on the port until the new limit is reached.", 
      "maximum": 256, 
      "minimum": 1, 
      "required": false, 
      "title": "Maximum number of ARP bindings", 
      "type": "int"
    }, 
    "arp_snooping_enabled": {
      "default": true, 
      "description": "Indicates whether ARP snooping is enabled", 
      "required": false, 
      "title": "Is ARP snooping enabled or not", 
      "type": "boolean"
    }
  }, 
  "title": "ARP Snooping Configuration", 
  "type": "object"
}

ArpTableRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "BaseListRequestParameters
  }, 
  "id": "ArpTableRequestParameters", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "edge_path": {
      "description": "Policy path of edge node. Edge node must be member of enforcement point. Edge path is required when interface specified is either service or loopback interface.", 
      "title": "Policy path of edge node", 
      "type": "string"
    }, 
    "enforcement_point_path": {
      "description": "String Path of the enforcement point. When not specified, routes from all enforcement-points are returned. This property is required for retrieving routes in CSV format.", 
      "title": "Enforcement point path", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Routes request parameters", 
  "type": "object"
}

AttachedInterfaceEntry (type)

{
  "additionalProperties": false, 
  "description": "The Attached interface is only effective for the segment port on Bare metal server.", 
  "id": "AttachedInterfaceEntry", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "app_intf_name": {
      "required": true, 
      "title": "The name of application interface", 
      "type": "string"
    }, 
    "default_gateway": {
      "$ref": "IPAddress, 
      "required": false, 
      "title": "Gateway IP"
    }, 
    "migrate_intf": {
      "description": "IP configuration on migrate_intf will migrate to app_intf_name. It is used for Management and Application sharing the same IP.", 
      "required": false, 
      "title": "Interface name to migrate", 
      "type": "string"
    }, 
    "routing_table": {
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Routing rules", 
      "type": "array"
    }
  }, 
  "title": "Attached interface information for Bare metal server", 
  "type": "object"
}

Attribute (type)

{
  "description": "Attribute specific to a partner. There attributes are passed on to the partner appliance and is opaque to the NSX Manager. The Attributes used by the partner applicance.", 
  "id": "Attribute", 
  "module_id": "ServiceInsertionCommonTypes", 
  "properties": {
    "attribute_type": {
      "description": "Attribute Type can be of any of the allowed enum type.", 
      "enum": [
        "IP_ADDRESS", 
        "PORT", 
        "PASSWORD", 
        "STRING", 
        "LONG", 
        "BOOLEAN"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "Attributetype.", 
      "type": "string"
    }, 
    "display_name": {
      "description": "Attribute display name string value.", 
      "readonly": false, 
      "required": false, 
      "title": "Display name", 
      "type": "string"
    }, 
    "key": {
      "description": "Attribute key string value.", 
      "readonly": false, 
      "required": true, 
      "title": "key", 
      "type": "string"
    }, 
    "read_only": {
      "default": false, 
      "description": "Read only Attribute cannot be overdidden by service instance/deployment.", 
      "readonly": false, 
      "required": false, 
      "title": "read only", 
      "type": "boolean"
    }, 
    "value": {
      "description": "Attribute value string value.", 
      "readonly": false, 
      "required": false, 
      "title": "value", 
      "type": "string"
    }
  }, 
  "title": "Attributes", 
  "type": "object"
}

AttributeVal (type)

{
  "description": "Contains type specific properties of generic realized entity", 
  "id": "AttributeVal", 
  "module_id": "PolicyRealizedState", 
  "properties": {
    "data_type": {
      "description": "Datatype of the property", 
      "enum": [
        "STRING", 
        "DATE", 
        "INTEGER", 
        "BOOLEAN"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Datatype of property represented by this attribute", 
      "type": "string"
    }, 
    "key": {
      "description": "Attribute key", 
      "required": false, 
      "title": "Key for the attribute value", 
      "type": "string"
    }, 
    "multivalue": {
      "description": "If attribute has a single value or collection of values", 
      "readonly": true, 
      "title": "multivalue flag", 
      "type": "boolean"
    }, 
    "values": {
      "description": "List of attribute values", 
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "required": false, 
      "title": "List of values for the attribute", 
      "type": "array"
    }
  }, 
  "title": "Attribute values of realized type", 
  "type": "object"
}

AuthenticationPolicyProperties (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "AuthenticationPolicyProperties", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "api_failed_auth_lockout_period": {
      "default": 900, 
      "description": "Once a lockout occurs, the account remains locked out of the API for this time period. Only applies to NSX Manager nodes. Ignored on other node types.", 
      "minimum": 0, 
      "title": "Lockout period in seconds", 
      "type": "integer"
    }, 
    "api_failed_auth_reset_period": {
      "default": 900, 
      "description": "In order to trigger an account lockout, all authentication failures must occur in this time window. If the reset period expires, the failed login count is reset to zero. Only applies to NSX Manager nodes. Ignored on other node types.", 
      "minimum": 0, 
      "title": "Period, in seconds, for authentication failures to trigger lockout", 
      "type": "integer"
    }, 
    "api_max_auth_failures": {
      "default": 5, 
      "description": "Only applies to NSX Manager nodes. Ignored on other node types.", 
      "minimum": 0, 
      "title": "Number of authentication failures that trigger API lockout", 
      "type": "integer"
    }, 
    "cli_failed_auth_lockout_period": {
      "default": 900, 
      "description": "Once a lockout occurs, the account remains locked out of the CLI for this time period. While the lockout period is in effect, additional authentication attempts restart the lockout period, even if a valid password is specified.", 
      "minimum": 0, 
      "title": "Lockout period in seconds", 
      "type": "integer"
    }, 
    "cli_max_auth_failures": {
      "default": 5, 
      "minimum": 0, 
      "title": "Number of authentication failures that trigger CLI lockout", 
      "type": "integer"
    }, 
    "minimum_password_length": {
      "default": 8, 
      "minimum": 8, 
      "title": "Minimum number of characters required in account passwords", 
      "type": "integer"
    }
  }, 
  "title": "Configuration of authentication policies for the NSX node", 
  "type": "object"
}

AuthenticationScheme (type)

{
  "additionalProperties": {}, 
  "id": "AuthenticationScheme", 
  "properties": {
    "scheme_name": {
      "required": true, 
      "title": "Authentication scheme name", 
      "type": "string"
    }
  }, 
  "type": "object"
}

AutoRds (type)

{
  "description": "This object holds auto assigned route distinguishers for Layer 2 and Layer 3 configurations.", 
  "id": "AutoRds", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "l2_auto_rds": {
      "items": {
        "$ref": "L2AutoRD
      }, 
      "title": "List of layer 2 Auto assigned Route Distinguisher", 
      "type": "array"
    }, 
    "l3_auto_rd": {
      "description": "This field is auto assigned by the system. The auto RD seed is populated when user does not assign a route_distinguisher field in the gateway.", 
      "title": "Layer 3 Auto assigned Route Distinguisher", 
      "type": "string"
    }
  }, 
  "title": "Auto assigned Route Distinguishers", 
  "type": "object"
}

Axes (type)

{
  "additionalProperties": false, 
  "description": "Represents X and Y axes of a graph. For a multi-graph, the same axes are shared by all the graphs.", 
  "id": "Axes", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "properties": {
    "x_label": {
      "$ref": "Label, 
      "decription": "Describes the X axis of a graph. If x_label is not specified, the label will not appear for X axis.", 
      "title": "Label for X axis of a graph"
    }, 
    "y_label": {
      "$ref": "Label, 
      "decription": "Describes the Y axis of a graph. If y_label is not specified, the label will not appear for Y axis.", 
      "title": "Label for Y axis of a graph"
    }
  }, 
  "title": "Axes of a graph", 
  "type": "object"
}

BackupConfiguration (type)

{
  "additionalProperties": false, 
  "id": "BackupConfiguration", 
  "module_id": "BackupConfiguration", 
  "properties": {
    "after_inventory_update_interval": {
      "maximum": 86400, 
      "minimum": 300, 
      "required": false, 
      "title": "A number of seconds after a last backup, that needs to pass, before a topology change will trigger a generation of a new cluster/node backups. If parameter is not provided, then changes in a topology will not trigger a generation of cluster/node backups.", 
      "type": "integer"
    }, 
    "backup_enabled": {
      "default": false, 
      "title": "true if automated backup is enabled", 
      "type": "boolean"
    }, 
    "backup_schedule": {
      "$ref": "BackupSchedule, 
      "title": "Set when backups should be taken - on a weekly schedule or at regular intervals."
    }, 
    "inventory_summary_interval": {
      "default": 240, 
      "maximum": 3600, 
      "minimum": 30, 
      "title": "The minimum number of seconds between each upload of the inventory summary to backup server.", 
      "type": "integer"
    }, 
    "passphrase": {
      "description": "Passphrase used to encrypt backup files. The passphrase specified must be at least 8 characters in length and must contain at least one lowercase, one uppercase, one numeric character and one special character (any other non-space character).", 
      "pattern": "^$|^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)(?=.*[^a-zA-Z\\d\\s]).{8,}$", 
      "sensitive": true, 
      "title": "Passphrase used to encrypt backup files.", 
      "type": "string", 
      "validation_msg_key": "com.vmware.nsx.validation.constraints.BackupRestore.weak_passprase.message"
    }, 
    "remote_file_server": {
      "$ref": "RemoteFileServer, 
      "required": true, 
      "title": "The server to which backups will be sent."
    }
  }, 
  "title": "Configuration for taking manual/automated backup", 
  "type": "object"
}

BackupFrameRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "Parameters (site_id, etc), that describes a backup/restore frame", 
  "id": "BackupFrameRequestParameters", 
  "module_id": "BackupConfiguration", 
  "properties": {
    "frame_type": {
      "default": "LOCAL_LOCAL_MANAGER", 
      "description": "This attribute is used to indicate the service on current site or other site for which backup is handled in a frame. LOCAL_LOCAL_MANAGER corresponds to local LM of the site. LOCAL_MANAGER cprresponds to LM of other site.", 
      "enum": [
        "GLOBAL_MANAGER", 
        "LOCAL_MANAGER", 
        "LOCAL_LOCAL_MANAGER", 
        "NSX_INTELLIGENCE"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Frame type", 
      "type": "string"
    }, 
    "site_id": {
      "default": "localhost", 
      "description": "Site ID of LM site, which will be supported in a frame", 
      "required": false, 
      "title": "Site ID", 
      "type": "string"
    }
  }, 
  "title": "Backup Frame Request Parameters", 
  "type": "object"
}

BackupOperationHistory (type)

{
  "additionalProperties": false, 
  "id": "BackupOperationHistory", 
  "module_id": "BackupConfiguration", 
  "properties": {
    "cluster_backup_statuses": {
      "items": {
        "$ref": "BackupOperationStatus
      }, 
      "required": false, 
      "title": "Statuses of previous cluser backups", 
      "type": "array"
    }, 
    "inventory_backup_statuses": {
      "items": {
        "$ref": "BackupOperationStatus
      }, 
      "required": false, 
      "title": "Statuses of previous inventory backups", 
      "type": "array"
    }, 
    "node_backup_statuses": {
      "items": {
        "$ref": "BackupOperationStatus
      }, 
      "required": false, 
      "title": "Statuses of previous node backups", 
      "type": "array"
    }
  }, 
  "title": "Past backup operation details", 
  "type": "object"
}

BackupOperationStatus (type)

{
  "additionalProperties": false, 
  "id": "BackupOperationStatus", 
  "module_id": "BackupConfiguration", 
  "properties": {
    "backup_id": {
      "required": true, 
      "title": "Unique identifier of a backup", 
      "type": "string"
    }, 
    "end_time": {
      "$ref": "EpochMsTimestamp, 
      "required": false, 
      "title": "Time when operation was ended"
    }, 
    "error_code": {
      "enum": [
        "BACKUP_NOT_RUN_ON_MASTER", 
        "BACKUP_SERVER_UNREACHABLE", 
        "BACKUP_AUTHENTICATION_FAILURE", 
        "BACKUP_PERMISSION_ERROR", 
        "BACKUP_TIMEOUT", 
        "BACKUP_BAD_FINGERPRINT", 
        "BACKUP_GENERIC_ERROR"
      ], 
      "required": false, 
      "title": "Error code", 
      "type": "string"
    }, 
    "error_message": {
      "required": false, 
      "title": "Error code details", 
      "type": "string"
    }, 
    "start_time": {
      "$ref": "EpochMsTimestamp, 
      "required": false, 
      "title": "Time when operation was started"
    }, 
    "success": {
      "required": true, 
      "title": "True if backup is successfully completed, else false", 
      "type": "boolean"
    }
  }, 
  "readOnly": true, 
  "title": "Backup operation status", 
  "type": "object"
}

BackupOverview (type)

{
  "description": "Data for a single backup/restore card", 
  "extends": {
    "$ref": "ClusterBackupInfoListResult
  }, 
  "id": "BackupOverview", 
  "module_id": "BackupConfiguration", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "backup_config": {
      "$ref": "BackupConfiguration, 
      "description": "Configuration to generate a manual/automated backup", 
      "required": true, 
      "title": "Backup configuration"
    }, 
    "backup_operation_history": {
      "$ref": "BackupOperationHistory, 
      "description": "Status of the last backup execution per component", 
      "required": true, 
      "title": "Last backup status"
    }, 
    "current_backup_operation_status": {
      "$ref": "CurrentBackupOperationStatus, 
      "description": "Backup status decribes type, phase, success/failure and time of a | latest backup execution", 
      "required": true, 
      "title": "Current backup status"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "restore_status": {
      "$ref": "ClusterRestoreStatus, 
      "description": "Status of restore process executing/executed on appliance", 
      "required": true, 
      "title": "Current restore status"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "ClusterBackupInfo
      }, 
      "readonly": true, 
      "required": true, 
      "title": "List of timestamps of backed-up cluster files", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Backup overview", 
  "type": "object"
}

BackupOverviewRequestParameters (type)

{
  "description": "Parameters, that REST API client needs to provide, in order to get data for a backup/restore card with or without a list of generated backups.", 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "BackupOverviewRequestParameters", 
  "module_id": "BackupConfiguration", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "frame_type": {
      "default": "LOCAL_LOCAL_MANAGER", 
      "description": "This attribute is used to indicate the service on current site or other site for which backup is handled in a frame. LOCAL_LOCAL_MANAGER corresponds to local LM of the site. LOCAL_MANAGER cprresponds to LM of other site.", 
      "enum": [
        "GLOBAL_MANAGER", 
        "LOCAL_MANAGER", 
        "LOCAL_LOCAL_MANAGER", 
        "NSX_INTELLIGENCE"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Frame type", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "show_backups_list": {
      "default": true, 
      "description": "True to request a list of backups", 
      "required": false, 
      "title": "Need a list of backups", 
      "type": "boolean"
    }, 
    "site_id": {
      "default": "localhost", 
      "description": "UUID of LM site, which will be supported in a frame", 
      "required": false, 
      "title": "UUID of the site", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Backup overview request parameters", 
  "type": "object"
}

BackupSchedule (type)

{
  "abstract": true, 
  "id": "BackupSchedule", 
  "module_id": "BackupConfiguration", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "resource_type"
  }, 
  "properties": {
    "resource_type": {
      "enum": [
        "WeeklyBackupSchedule", 
        "IntervalBackupSchedule"
      ], 
      "required": true, 
      "title": "Schedule type", 
      "type": "string"
    }
  }, 
  "title": "Abstract base type for Weekly or Interval Backup Schedule", 
  "type": "object"
}

BackupUiFramesInfo (type)

{
  "id": "BackupUiFramesInfo", 
  "properties": {
    "api_endpoint": {
      "enum": [
        "global-manager", 
        "nsxapi", 
        "ica"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "prefix to be used for api call", 
      "type": "string"
    }, 
    "frame_type": {
      "enum": [
        "GLOBAL_MANAGER", 
        "LOCAL_MANAGER", 
        "LOCAL_LOCAL_MANAGER", 
        "NSX_INTELLIGENCE"
      ], 
      "help_detail": "This attribute is used to indicate the service on current\nsite or other site for which backup is handled.\nLOCAL_LOCAL_MANAGER corresponds to local LM of the site.\nLOCAL_MANAGER cprresponds to LM of other site.\n", 
      "readonly": true, 
      "required": true, 
      "title": "Type of service, for which backup is handled", 
      "type": "string"
    }, 
    "site_id": {
      "readonly": true, 
      "required": true, 
      "title": "Id of the site", 
      "type": "string"
    }, 
    "site_version": {
      "readonly": true, 
      "required": true, 
      "title": "Version of the site", 
      "type": "string"
    }
  }, 
  "type": "object"
}

BackupUiFramesInfoList (type)

{
  "id": "BackupUiFramesInfoList", 
  "properties": {
    "backup_frames_list": {
      "items": {
        "$ref": "BackupUiFramesInfo
      }, 
      "readonly": true, 
      "required": true, 
      "title": "List of backup frames(and metadata) to be displayed in UI", 
      "type": "array"
    }
  }, 
  "type": "object"
}

BaseConsolidatedStatusPerEnforcementPoint (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "description": "Consolidated Realized Status Per Enforcement Point.", 
  "extends": {
    "$ref": "PolicyRuntimeInfoPerEP
  }, 
  "id": "BaseConsolidatedStatusPerEnforcementPoint", 
  "module_id": "PolicyRealizedState", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "resource_type"
  }, 
  "properties": {
    "alarm": {
      "$ref": "PolicyRuntimeAlarm, 
      "description": "Alarm information details.", 
      "readonly": true, 
      "title": "Alarm Information Details"
    }, 
    "consolidated_status": {
      "$ref": "ConsolidatedStatus, 
      "description": "Consolidated Realized Status of an Intent object per enforcement point.", 
      "readonly": true, 
      "title": "Consolidated Realized Status"
    }, 
    "enforcement_point_id": {
      "description": "Enforcement Point Id.", 
      "readonly": true, 
      "title": "Enforcement Point Id", 
      "type": "string"
    }, 
    "enforcement_point_path": {
      "description": "Policy Path referencing the enforcement point where the info is fetched.", 
      "readonly": true, 
      "title": "Enforcement point Path", 
      "type": "string"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "site_path": {
      "description": "The site where this enforcement point resides.", 
      "readonly": true, 
      "title": "Site Path", 
      "type": "string"
    }
  }, 
  "title": "Base class for ConsolidatedStatusPerEnforcementPoint", 
  "type": "object"
}

BaseEndpoint (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "description": "Represents an endpoint which will be used as subject in rule. It is a polymorphic type object which can be either of the types - 1. Virtual 2. Logical We have 2 separate objects representing these 2 types. VirtualEndPoint for Virtual type and ServiceInstanceEndpoint for Logical.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "BaseEndpoint", 
  "module_id": "PolicyServiceInsertion", 
  "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: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": [
        "VirtualEndpoint", 
        "ServiceInstanceEndpoint"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "target_ips": {
      "description": "IPs where either inbound or outbound traffic is to be redirected.", 
      "items": {
        "$ref": "IPInfo
      }, 
      "maxItems": 1, 
      "minItems": 1, 
      "required": true, 
      "title": "IP addresses to redirect the traffic to", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "An endpoint to be used in redirection rule", 
  "type": "object"
}

BaseListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "BaseListRequestParameters", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "enforcement_point_path": {
      "description": "String Path of the enforcement point. When not specified, routes from all enforcement-points are returned. This property is required for retrieving routes in CSV format.", 
      "title": "Enforcement point path", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Routes request parameters", 
  "type": "object"
}

BasePolicyServiceInstance (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "description": "Represents an instance of partner Service and its configuration.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "BasePolicyServiceInstance", 
  "module_id": "PolicyServiceInsertion", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "deployment_mode": {
      "default": "ACTIVE_STANDBY", 
      "description": "Deployment mode specifies how the partner appliance will be deployed i.e. in HA or standalone mode.", 
      "enum": [
        "STAND_ALONE", 
        "ACTIVE_STANDBY"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "Deployment Mode", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "partner_service_name": {
      "description": "Unique name of Partner Service in the Marketplace", 
      "required": true, 
      "title": "Name of Partner Service", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "transport_type": {
      "default": "L2_BRIDGE", 
      "description": "Transport to be used while deploying Service-VM.", 
      "enum": [
        "L2_BRIDGE", 
        "L3_ROUTED"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "Transport Type", 
      "type": "string"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Represents an instance of partner Service and its configuration", 
  "type": "object"
}

BaseRule (type)

{
  "additionalProperties": false, 
  "description": "A rule indicates the action to be performed for various types of traffic flowing between workload groups.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "BaseRule", 
  "module_id": "Policy", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "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 domains. Along with paths we support IP Address of type IPv4 and IPv6. IP Address can be in one of the format(CIDR, IP Address, Range of IP Address). 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.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 128, 
      "required": false, 
      "title": "Destination group paths", 
      "type": "array"
    }, 
    "destinations_excluded": {
      "default": false, 
      "description": "If set to true, the rule gets applied on all the groups that are NOT part of the destination groups. If false, the rule applies to the destination groups", 
      "readonly": false, 
      "required": false, 
      "title": "Negation of destination groups", 
      "type": "boolean"
    }, 
    "direction": {
      "default": "IN_OUT", 
      "description": "Define direction of traffic.", 
      "enum": [
        "IN", 
        "OUT", 
        "IN_OUT"
      ], 
      "required": false, 
      "title": "Direction", 
      "type": "string"
    }, 
    "disabled": {
      "default": false, 
      "description": "Flag to disable the rule. Default is enabled.", 
      "readonly": false, 
      "required": false, 
      "title": "Flag to disable the rule", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ip_protocol": {
      "description": "Type of IP packet that should be matched while enforcing the rule. The value is set to IPV4_IPV6 for Layer3 rule if not specified. For Layer2/Ether rule the value must be null.", 
      "enum": [
        "IPV4", 
        "IPV6", 
        "IPV4_IPV6"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "IPv4 vs IPv6 packet type", 
      "type": "string"
    }, 
    "is_default": {
      "description": "A flag to indicate whether rule is a default rule.", 
      "readonly": true, 
      "required": false, 
      "title": "Default rule flag", 
      "type": "boolean"
    }, 
    "logged": {
      "default": false, 
      "description": "Flag to enable packet logging. Default is disabled.", 
      "readonly": false, 
      "required": false, 
      "title": "Enable logging flag", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "notes": {
      "description": "Text for additional notes on changes.", 
      "maxLength": 2048, 
      "readonly": false, 
      "required": false, 
      "title": "Text for additional notes on changes", 
      "type": "string"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "profiles": {
      "description": "Holds the list of layer 7 service profile paths. These profiles accept attributes and sub-attributes of various network services (e.g. L4 AppId, encryption algorithm, domain name, etc) as key value pairs.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 128, 
      "required": false, 
      "title": "Layer 7 service profiles", 
      "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"
    }, 
    "rule_id": {
      "description": "This is a unique 4 byte positive number that is assigned by the system.  This rule id is passed all the way down to the data path. The first 1GB (1000 to 2^30) will be shared by GM and LM with zebra style striped number space. For E.g 1000 to (1Million -1) by LM, (1M - 2M-1) by GM and so on.", 
      "readonly": true, 
      "required": false, 
      "title": "Unique rule ID", 
      "type": "integer"
    }, 
    "scope": {
      "description": "The list of policy paths where the rule is applied LR/Edge/T0/T1/LRP etc. Note that a given rule can be applied on multiple LRs/LRPs.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 128, 
      "required": false, 
      "type": "array"
    }, 
    "sequence_number": {
      "description": "This field is used to resolve conflicts between multiple Rules under Security or Gateway Policy for a Domain If no sequence number is specified in the payload, a value of 0 is assigned by default. If there are multiple rules with the same sequence number then their order is not deterministic. If a specific order of rules is desired, then one has to specify unique sequence numbers or use the POST request on the rule entity with a query parameter action=revise to let the framework assign a sequence number", 
      "minimum": 0, 
      "required": false, 
      "title": "Sequence number of the this Rule", 
      "type": "int"
    }, 
    "service_entries": {
      "description": "In order to specify raw services this can be used, along with services which contains path to services. This can be empty or null.", 
      "items": {
        "$ref": "ServiceEntry
      }, 
      "maxItems": 128, 
      "required": false, 
      "title": "Raw services", 
      "type": "array"
    }, 
    "services": {
      "description": "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.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 128, 
      "required": false, 
      "title": "Names of services", 
      "type": "array"
    }, 
    "source_groups": {
      "description": "We need paths as duplicate names may exist for groups under different domains. Along with paths we support IP Address of type IPv4 and IPv6. IP Address can be in one of the format(CIDR, IP Address, Range of IP Address). 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.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 128, 
      "required": false, 
      "title": "Source group paths", 
      "type": "array"
    }, 
    "sources_excluded": {
      "default": false, 
      "description": "If set to true, the rule gets applied on all the groups that are NOT part of the source groups. If false, the rule applies to the source groups", 
      "readonly": false, 
      "required": false, 
      "title": "Negation of source groups", 
      "type": "boolean"
    }, 
    "tag": {
      "description": "User level field which will be printed in CLI and packet logs.", 
      "required": false, 
      "title": "Tag applied on the rule", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "A rule represent base properties for ,dfw, forwarding, redirection rule", 
  "type": "object"
}

BaseRuleListResult (type)

{
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "BaseRuleListResult", 
  "module_id": "Policy", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of Rules", 
  "type": "object"
}

BaseTier0Interface (type)

{
  "additionalProperties": false, 
  "description": "Tier-0 interface configuration for external connectivity.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "BaseTier0Interface", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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"
    }, 
    "subnets": {
      "description": "Specify IP address and network prefix for interface.", 
      "items": {
        "$ref": "InterfaceSubnet
      }, 
      "minItems": 1, 
      "required": true, 
      "title": "IP address and subnet specification for interface", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Tier-0 interface configuration", 
  "type": "object"
}

BasicAuthenticationScheme (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "AuthenticationScheme
  }, 
  "id": "BasicAuthenticationScheme", 
  "properties": {
    "password": {
      "required": true, 
      "sensitive": true, 
      "title": "Password to authenticate with", 
      "type": "string"
    }, 
    "scheme_name": {
      "enum": [
        "basic"
      ], 
      "required": true, 
      "title": "Authentication scheme name", 
      "type": "string"
    }, 
    "username": {
      "pattern": "^.+$", 
      "required": true, 
      "title": "User name to authenticate with", 
      "type": "string"
    }
  }, 
  "type": "object"
}

BatchParameter (type)

{
  "id": "BatchParameter", 
  "module_id": "Common", 
  "properties": {
    "atomic": {
      "default": false, 
      "description": "use this flag if you want transactional atomicity", 
      "required": false, 
      "title": "transactional atomicity for the batch of requests embedded in the batch list", 
      "type": "boolean"
    }
  }, 
  "title": "Options that affect how batch operations are processed", 
  "type": "object"
}

BatchRequest (type)

{
  "id": "BatchRequest", 
  "module_id": "Common", 
  "properties": {
    "continue_on_error": {
      "default": true, 
      "description": "Flag to decide if we will continue processing subsequent requests in case of current error for atomic = false.", 
      "required": false, 
      "type": "boolean"
    }, 
    "requests": {
      "items": {
        "$ref": "BatchRequestItem
      }, 
      "sensitive": true, 
      "type": "array"
    }
  }, 
  "title": "A set of operations to be performed in a single batch", 
  "type": "object"
}

BatchRequestItem (type)

{
  "id": "BatchRequestItem", 
  "module_id": "Common", 
  "properties": {
    "body": {
      "type": "object"
    }, 
    "method": {
      "description": "http method type", 
      "enum": [
        "GET", 
        "POST", 
        "PUT", 
        "DELETE", 
        "PATCH"
      ], 
      "required": true, 
      "title": "method type(POST/PUT/DELETE/UPDATE)", 
      "type": "string"
    }, 
    "uri": {
      "description": "relative uri (path and args), of the call including resource id (if this is a POST/DELETE), exclude hostname and port and prefix, exploded form of parameters", 
      "required": true, 
      "title": "Internal uri of the call", 
      "type": "string"
    }
  }, 
  "title": "A single request within a batch of operations", 
  "type": "object"
}

BatchResponse (type)

{
  "additionalProperties": false, 
  "id": "BatchResponse", 
  "module_id": "Common", 
  "properties": {
    "has_errors": {
      "description": "Indicates if any of the APIs failed", 
      "title": "errors indicator", 
      "type": "boolean"
    }, 
    "results": {
      "items": {
        "$ref": "BatchResponseItem
      }, 
      "required": true, 
      "title": "Bulk list results", 
      "type": "array"
    }, 
    "rolled_back": {
      "description": "Optional flag indicating that all items were rolled back even if succeeded initially", 
      "title": "indicates if all items were rolled back.", 
      "type": "boolean"
    }
  }, 
  "title": "The reponse to a batch operation", 
  "type": "object"
}

BatchResponseItem (type)

{
  "id": "BatchResponseItem", 
  "module_id": "Common", 
  "properties": {
    "body": {
      "description": "object returned by api", 
      "required": false, 
      "title": "object returned by api", 
      "type": "object"
    }, 
    "code": {
      "description": "http status code", 
      "required": true, 
      "title": "object returned by api", 
      "type": "integer"
    }, 
    "headers": {
      "description": "The headers returned by the API call", 
      "title": "object returned by api", 
      "type": "object"
    }
  }, 
  "title": "A single respose in a list of batched responses", 
  "type": "object"
}

BfdProfile (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "BfdProfile", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "interval": {
      "default": 500, 
      "description": "Time interval between heartbeat packets in milliseconds.", 
      "maximum": 60000, 
      "minimum": 50, 
      "title": "Time interval between heartbeat packets in milliseconds", 
      "type": "int"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "multiple": {
      "default": 3, 
      "description": "Declare dead multiple. Number of times heartbeat packet is missed before BFD declares the neighbor is down.", 
      "maximum": 16, 
      "minimum": 2, 
      "title": "Declare dead multiple", 
      "type": "int"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Bidirectional Forwarding Detection configuration for BGP peers", 
  "type": "object"
}

BfdProfileListResult (type)

{
  "additionalProperties": false, 
  "description": "Paged Collection of BfdProfile.", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "BfdProfileListResult", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Bfd Profile list results.", 
      "items": {
        "$ref": "BfdProfile
      }, 
      "required": true, 
      "title": "Bfd Profile List Results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of BfdProfile", 
  "type": "object"
}

BgpAddressFamily (type)

{
  "additionalProperties": false, 
  "id": "BgpAddressFamily", 
  "module_id": "AggSvcLogicalRouter", 
  "properties": {
    "in_prefix_count": {
      "description": "Count of in prefixes", 
      "readonly": true, 
      "required": false, 
      "title": "Count of in prefixes", 
      "type": "integer"
    }, 
    "out_prefix_count": {
      "description": "Count of out prefixes", 
      "readonly": true, 
      "required": false, 
      "title": "Count of out prefixes", 
      "type": "integer"
    }, 
    "type": {
      "description": "BGP address family type", 
      "enum": [
        "IPV4_UNICAST", 
        "VPNV4_UNICAST", 
        "IPV6_UNICAST", 
        "L2VPN_EVPN"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "BGP address family type", 
      "type": "string"
    }
  }, 
  "type": "object"
}

BgpBfdConfig (type)

{
  "additionalProperties": false, 
  "id": "BgpBfdConfig", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "enabled": {
      "default": false, 
      "description": "Flag to enable BFD cofiguration.", 
      "title": "Flag to enable BFD cofiguration", 
      "type": "boolean"
    }, 
    "interval": {
      "default": 500, 
      "description": "Time interval between heartbeat packets in milliseconds.", 
      "maximum": 60000, 
      "minimum": 50, 
      "title": "Time interval between heartbeat packets in milliseconds", 
      "type": "int"
    }, 
    "multiple": {
      "default": 3, 
      "description": "Declare dead multiple. Number of times heartbeat packet is missed before BFD declares the neighbor is down.", 
      "maximum": 16, 
      "minimum": 2, 
      "title": "Declare dead multiple", 
      "type": "int"
    }
  }, 
  "title": "BFD configuration for BGP peers", 
  "type": "object"
}

BgpGracefulRestartConfig (type)

{
  "additionalProperties": false, 
  "description": "Configuration field to hold BGP restart mode and timer.", 
  "id": "BgpGracefulRestartConfig", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "mode": {
      "default": "HELPER_ONLY", 
      "description": "If mode is DISABLE, then graceful restart and helper modes are disabled. If mode is GR_AND_HELPER, then both graceful restart and helper modes are enabled. If mode is HELPER_ONLY, then helper mode is enabled. HELPER_ONLY mode is the ability for a BGP speaker to indicate its ability to preserve forwarding state during BGP restart. GRACEFUL_RESTART mode is the ability of a BGP speaker to advertise its restart to its peers.", 
      "enum": [
        "DISABLE", 
        "GR_AND_HELPER", 
        "HELPER_ONLY"
      ], 
      "required": false, 
      "title": "BGP Graceful Restart Configuration Mode", 
      "type": "string"
    }, 
    "timer": {
      "$ref": "BgpGracefulRestartTimer, 
      "description": "Configuration field to hold BGP restart timers.", 
      "title": "BGP Graceful Restart Timer"
    }
  }, 
  "title": "BGP Graceful Restart Configuration", 
  "type": "object"
}

BgpGracefulRestartTimer (type)

{
  "additionalProperties": false, 
  "description": "Configuration field to hold BGP restart timers", 
  "id": "BgpGracefulRestartTimer", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "restart_timer": {
      "default": 180, 
      "description": "Maximum time taken (in seconds) for a BGP session to be established after a restart. This can be used to speed up routing convergence by its peer in case the BGP speaker does not come back up after a restart. If the session is not re-established within this timer,  the receiving speaker will delete all the stale routes from that peer.", 
      "maximum": 3600, 
      "minimum": 1, 
      "title": "BGP Graceful Restart Timer", 
      "type": "integer"
    }, 
    "stale_route_timer": {
      "default": 600, 
      "description": "Maximum time (in seconds) before stale routes are removed from the RIB (Routing Information Base) when BGP restarts.", 
      "maximum": 3600, 
      "minimum": 1, 
      "title": "BGP Stale Route Timer", 
      "type": "integer"
    }
  }, 
  "title": "BGP Graceful Restart Timers", 
  "type": "object"
}

BgpNeighborConfig (type)

{
  "additionalProperties": false, 
  "description": "Contains information necessary to configure a BGP neighbor.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "BgpNeighborConfig", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "allow_as_in": {
      "default": false, 
      "required": false, 
      "title": "Flag to enable allowas_in option for BGP neighbor", 
      "type": "boolean"
    }, 
    "bfd": {
      "$ref": "BgpBfdConfig, 
      "description": "BFD configuration for failure detection. BFD is enabled with default values when not configured.", 
      "title": "BFD configuration for failure detection"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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"
    }, 
    "graceful_restart_mode": {
      "description": "If mode is DISABLE, then graceful restart and helper modes are disabled. If mode is GR_AND_HELPER, then both graceful restart and helper modes are enabled. If mode is HELPER_ONLY, then helper mode is enabled. HELPER_ONLY mode is the ability for a BGP speaker to indicate its ability to preserve forwarding state during BGP restart. GRACEFUL_RESTART mode is the ability of a BGP speaker to advertise its restart to its peers.", 
      "enum": [
        "DISABLE", 
        "GR_AND_HELPER", 
        "HELPER_ONLY"
      ], 
      "title": "BGP Graceful Restart Configuration Mode", 
      "type": "string"
    }, 
    "hold_down_time": {
      "default": 180, 
      "description": "Wait time in seconds before declaring peer dead.", 
      "maximum": 65535, 
      "minimum": 1, 
      "title": "Wait time in seconds before declaring peer dead", 
      "type": "int"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "in_route_filters": {
      "deprecated": true, 
      "description": "Specify path of prefix-list or route map to filter routes for IN direction. This property is deprecated, use route_filtering instead. Specifying different values for both properties will result in error.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 1, 
      "required": false, 
      "title": "Prefix-list or route map path for IN direction", 
      "type": "array"
    }, 
    "keep_alive_time": {
      "default": 60, 
      "description": "Interval (in seconds) between keep alive messages sent to peer.", 
      "maximum": 65535, 
      "minimum": 1, 
      "title": "Interval between keep alive messages sent to peer", 
      "type": "int"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "maximum_hop_limit": {
      "default": 1, 
      "description": "Maximum number of hops allowed to reach BGP neighbor.", 
      "maximum": 255, 
      "minimum": 1, 
      "title": "Maximum number of hops allowed to reach BGP neighbor", 
      "type": "int"
    }, 
    "neighbor_address": {
      "$ref": "IPAddress, 
      "required": true, 
      "title": "Neighbor IP Address"
    }, 
    "out_route_filters": {
      "deprecated": true, 
      "description": "Specify path of prefix-list or route map to filter routes for OUT direction. When not specified, a built-in prefix-list named 'prefixlist-out-default' is automatically applied. This property is deprecated, use route_filtering instead. Specifying different values for both properties will result in error.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 1, 
      "required": false, 
      "title": "Prefix-list or route map path for OUT direction", 
      "type": "array"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "password": {
      "description": "Specify password for BGP neighbor authentication. Empty string (\"\") clears existing password.", 
      "maxLength": 20, 
      "minLength": 0, 
      "sensitive": true, 
      "title": "Password", 
      "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"
    }, 
    "remote_as_num": {
      "required": true, 
      "title": "4 Byte ASN of the neighbor in ASPLAIN Format", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "route_filtering": {
      "description": "Enable address families and route filtering in each direction.", 
      "items": {
        "$ref": "BgpRouteFiltering
      }, 
      "maxItems": 2, 
      "required": false, 
      "title": "Enable address families and route filtering in each direction", 
      "type": "array"
    }, 
    "source_addresses": {
      "description": "Source addresses should belong to Tier0 external or loopback interface IP Addresses . BGP peering is formed from all these addresses. This property is mandatory when maximum_hop_limit is greater than 1.", 
      "items": {
        "$ref": "IPAddress
      }, 
      "maxItems": 8, 
      "required": false, 
      "title": "Source IP Addresses for BGP peering", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "BGP neighbor config", 
  "type": "object"
}

BgpNeighborConfigListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "BgpNeighborConfigListRequestParameters", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Routing Config list request parameters", 
  "type": "object"
}

BgpNeighborConfigListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "BgpNeighborConfigListResult", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "BgpNeighborConfig
      }, 
      "required": true, 
      "title": "BGP neighbor configs list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged collection of BGP Neighbor Configs", 
  "type": "object"
}

BgpNeighborRouteDetailsCsvRecord (type)

{
  "additionalProperties": false, 
  "description": "BGP neighbor learned/advertised route details.", 
  "extends": {
    "$ref": "CsvRecord
  }, 
  "id": "BgpNeighborRouteDetailsCsvRecord", 
  "module_id": "AggSvcLogicalRouter", 
  "properties": {
    "as_path": {
      "description": "BGP AS path attribute.", 
      "readonly": true, 
      "required": false, 
      "title": "AS path", 
      "type": "string"
    }, 
    "local_pref": {
      "description": "BGP Local Preference attribute.", 
      "readonly": true, 
      "required": false, 
      "title": "Local preference", 
      "type": "integer"
    }, 
    "logical_router_id": {
      "description": "Logical router id", 
      "readonly": true, 
      "required": true, 
      "title": "Logical router id", 
      "type": "string"
    }, 
    "med": {
      "description": "BGP Multi Exit Discriminator attribute.", 
      "readonly": true, 
      "required": false, 
      "title": "Multi Exit Discriminator", 
      "type": "integer"
    }, 
    "neighbor_address": {
      "$ref": "IPAddress, 
      "description": "BGP neighbor peer IP address.", 
      "readonly": true, 
      "required": true, 
      "title": "Neighbor IP address"
    }, 
    "neighbor_id": {
      "description": "BGP neighbor id", 
      "readonly": true, 
      "required": true, 
      "title": "BGP neighbor id", 
      "type": "string"
    }, 
    "network": {
      "$ref": "IPCIDRBlock, 
      "description": "CIDR network address.", 
      "readonly": true, 
      "required": true, 
      "title": "CIDR network address"
    }, 
    "next_hop": {
      "$ref": "IPAddress, 
      "description": "Next hop IP address.", 
      "readonly": true, 
      "required": false, 
      "title": "Next hop IP address"
    }, 
    "source_address": {
      "$ref": "IPAddress, 
      "description": "BGP neighbor source address.", 
      "readonly": true, 
      "required": false, 
      "title": "BGP neighbor source address"
    }, 
    "transport_node_id": {
      "description": "Transport node id", 
      "readonly": true, 
      "required": true, 
      "title": "Transport node id", 
      "type": "string"
    }, 
    "weight": {
      "description": "BGP Weight attribute.", 
      "readonly": true, 
      "required": false, 
      "title": "Weight", 
      "type": "integer"
    }
  }, 
  "title": "BGP neighbor route details", 
  "type": "object"
}

BgpNeighborRouteDetailsInCsvFormat (type)

{
  "extends": {
    "$ref": "CsvListResult
  }, 
  "id": "BgpNeighborRouteDetailsInCsvFormat", 
  "module_id": "AggSvcLogicalRouter", 
  "properties": {
    "file_name": {
      "description": "File name set by HTTP server if API  returns CSV result as a file.", 
      "required": false, 
      "title": "File name", 
      "type": "string"
    }, 
    "results": {
      "items": {
        "$ref": "BgpNeighborRouteDetailsCsvRecord
      }, 
      "required": false, 
      "type": "array"
    }
  }, 
  "type": "object"
}

BgpNeighborRoutes (type)

{
  "additionalProperties": false, 
  "description": "BGP neighbor learned/advertised route details.", 
  "id": "BgpNeighborRoutes", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "egde_node_routes": {
      "description": "Array of BGP neighbor route details per edge node.", 
      "items": {
        "$ref": "RoutesPerTransportNode
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Route details per transport node", 
      "type": "array"
    }, 
    "enforcement_point_path": {
      "readonly": true, 
      "required": true, 
      "title": "Enforcement point policy path", 
      "type": "string"
    }, 
    "neighbor_path": {
      "readonly": true, 
      "required": true, 
      "title": "BGP neighbor policy path", 
      "type": "string"
    }
  }, 
  "title": "BGP neighbor route details", 
  "type": "object"
}

BgpNeighborRoutesListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "BgpNeighborRoutesListResult", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Paged Collection of Bgp neighbor routes.", 
      "items": {
        "$ref": "BgpNeighborRoutes
      }, 
      "required": false, 
      "title": "Paged Collection of Bgp neighbor routes", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

BgpRouteFiltering (type)

{
  "additionalProperties": false, 
  "id": "BgpRouteFiltering", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "address_family": {
      "description": "Address family type. If not configured, this property automatically derived for IPv4 & IPv6 peer configuration.", 
      "enum": [
        "IPV4", 
        "IPV6", 
        "L2VPN_EVPN"
      ], 
      "title": "Address family type", 
      "type": "string"
    }, 
    "enabled": {
      "default": true, 
      "description": "Flag to enable address family.", 
      "title": "Enable address family", 
      "type": "boolean"
    }, 
    "in_route_filters": {
      "description": "Specify path of prefix-list or route map to filter routes for IN direction.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 1, 
      "required": false, 
      "title": "Prefix-list or route map path for IN direction", 
      "type": "array"
    }, 
    "maximum_routes": {
      "description": "Maximum number of routes for the address family.", 
      "maximum": 1000000, 
      "minimum": 1, 
      "required": false, 
      "title": "Maximum number of routes for the address family", 
      "type": "int"
    }, 
    "out_route_filters": {
      "description": "Specify path of prefix-list or route map to filter routes for OUT direction. When not specified, a built-in prefix-list named 'prefixlist-out-default' is automatically applied.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 1, 
      "required": false, 
      "title": "Prefix-list or route map path for OUT direction", 
      "type": "array"
    }
  }, 
  "title": "Enable address_families and route filtering in each direction", 
  "type": "object"
}

BgpRoutesRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "BaseListRequestParameters
  }, 
  "id": "BgpRoutesRequestParameters", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "count": {
      "default": 1000, 
      "description": "Number of routes to return in response. Not used when routes are requested in CSV format.", 
      "minimum": 1, 
      "title": "Number of routes to retrieve", 
      "type": "int"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "enforcement_point_path": {
      "description": "String Path of the enforcement point. When not specified, routes from all enforcement-points are returned. This property is required for retrieving routes in CSV format.", 
      "title": "Enforcement point path", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "BGP Routes request parameters", 
  "type": "object"
}

BgpRoutingConfig (type)

{
  "additionalProperties": false, 
  "description": "Contains BGP routing configuration.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "BgpRoutingConfig", 
  "module_id": "PolicyConnectivity", 
  "policy_hierarchical_children": [
    "ChildBgpNeighborConfig"
  ], 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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"
    }, 
    "ecmp": {
      "description": "Flag to enable ECMP.", 
      "required": false, 
      "title": "Flag to enable ECMP", 
      "type": "boolean"
    }, 
    "enabled": {
      "description": "Flag to enable BGP configuration. Disabling will stop feature and BGP peering.", 
      "required": false, 
      "title": "Flag to enable BGP configuration", 
      "type": "boolean"
    }, 
    "graceful_restart": {
      "deprecated": true, 
      "description": "Flag to enable graceful restart. This field is deprecated, please use graceful_restart_config parameter for graceful restart configuration. If both parameters are set and consistent with each other (i.e. graceful_restart=false and graceful_restart_mode=HELPER_ONLY OR graceful_restart=true and graceful_restart_mode=GR_AND_HELPER) then this is allowed, but if inconsistent with each other then this is not allowed and validation error will be thrown.", 
      "required": false, 
      "title": "Flag to enable graceful restart", 
      "type": "boolean"
    }, 
    "graceful_restart_config": {
      "$ref": "BgpGracefulRestartConfig, 
      "description": "Configuration field to hold BGP Restart mode and timer.", 
      "title": "BGP Graceful Restart Configuration"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "inter_sr_ibgp": {
      "description": "Flag to enable inter SR IBGP configuration. When not specified, inter SR IBGP is automatically enabled if Tier-0 is created in ACTIVE_ACTIVE ha_mode.", 
      "required": false, 
      "title": "Enable inter SR IBGP configuration", 
      "type": "boolean"
    }, 
    "local_as_num": {
      "description": "Specify BGP AS number for Tier-0 to advertize to BGP peers. AS number can be specified in ASPLAIN (e.g., \"65546\") or ASDOT (e.g., \"1.10\") format. Empty string disables BGP feature. It is required by normal tier0 but not required in vrf tier0.", 
      "required": false, 
      "title": "BGP AS number in ASPLAIN/ASDOT Format", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "multipath_relax": {
      "description": "Flag to enable BGP multipath relax option.", 
      "required": false, 
      "title": "Flag to enable BGP multipath relax option", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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"
    }, 
    "route_aggregations": {
      "description": "List of routes to be aggregated.", 
      "items": {
        "$ref": "RouteAggregationEntry
      }, 
      "maxItems": 1000, 
      "required": false, 
      "title": "List of routes to be aggregated", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "BGP routing config", 
  "type": "object"
}

BinaryPacketData (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PacketData
  }, 
  "id": "BinaryPacketData", 
  "module_id": "Traceflow", 
  "polymorphic-type-descriptor": {
    "type-identifier": "BinaryPacketData"
  }, 
  "properties": {
    "frame_size": {
      "default": 128, 
      "description": "If the requested frame_size is too small (given the payload and traceflow metadata requirement of 16 bytes), the traceflow request will fail with an appropriate message.  The frame will be zero padded to the requested size.", 
      "maximum": 1000, 
      "minimum": 60, 
      "required": false, 
      "title": "Requested total size of the (logical) packet in bytes", 
      "type": "integer"
    }, 
    "payload": {
      "description": "Up to 1000 bytes of payload may be supplied (with a base64-encoded length of 1336 bytes.) Additional bytes of traceflow metadata will be appended to the payload. The payload must contain all headers (Ethernet, IP, etc). Note that VLAN is not supported in the logical space. Hence, payload must not contain 802.1Q headers.", 
      "maxLength": 1336, 
      "required": false, 
      "title": "RFC3548 compatible base64 encoded full payload", 
      "type": "string"
    }, 
    "resource_type": {
      "default": "FieldsPacketData", 
      "enum": [
        "BinaryPacketData", 
        "FieldsPacketData"
      ], 
      "required": true, 
      "title": "Packet configuration", 
      "type": "string"
    }, 
    "routed": {
      "required": false, 
      "title": "A flag, when set true, indicates that the traceflow packet is of L3 routing.", 
      "type": "boolean"
    }, 
    "transport_type": {
      "default": "UNICAST", 
      "enum": [
        "BROADCAST", 
        "UNICAST", 
        "MULTICAST", 
        "UNKNOWN"
      ], 
      "required": false, 
      "title": "transport type of the traceflow packet", 
      "type": "string"
    }
  }, 
  "type": "object"
}

BingdingMapStackStatusListRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "Request parameters for port/group/segment binding map mirror stack status.", 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "BingdingMapStackStatusListRequestParameters", 
  "module_id": "PolicyMonitoringProfileBinding", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "enforcement_point_path": {
      "description": "String path for the enforcement point.", 
      "required": false, 
      "title": "Binding map path enforcemnt point path to remote L3 mirror session", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Request parameters for binding map mirror stack status", 
  "type": "object"
}

BridgeProfileConfig (type)

{
  "additionalProperties": false, 
  "description": "configuration parameters for Bridge Profile", 
  "id": "BridgeProfileConfig", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "bridge_profile_path": {
      "description": "Same bridge profile can be configured on different segments. Each bridge profile on a segment must unique.", 
      "required": true, 
      "title": "Policy path to L2 Bridge profile", 
      "type": "string"
    }, 
    "uplink_teaming_policy_name": {
      "description": "The name of the switching uplink teaming policy for the bridge endpoint. This name corresponds to one fot he switching uplink teaming policy names listed in teh transport zone. When this property is not specified, the teaming policy is assigned by MP.", 
      "title": "Uplink Teaming Policy Name", 
      "type": "string"
    }, 
    "vlan_ids": {
      "description": "VLAN specification for bridge endpoint. Either VLAN ID or VLAN ranges can be specified. Not both.", 
      "items": {
        "type": "string"
      }, 
      "title": "VLAN IDs", 
      "type": "array"
    }, 
    "vlan_transport_zone_path": {
      "description": "VLAN transport zone should belong to the enforcment-point as the transport zone specified in the segment.", 
      "required": true, 
      "title": "Policy path to VLAN Transport Zone", 
      "type": "string"
    }
  }, 
  "title": "Bridge Profile Configuration", 
  "type": "object"
}

ByodPolicyServiceInstance (type)

{
  "additionalProperties": false, 
  "description": "Represents an instance of partner's service whose wiring will be done by partner itself. As partner does all the wiring, we call it as Byod - Bring your own device.", 
  "extends": {
    "$ref": "BasePolicyServiceInstance
  }, 
  "id": "ByodPolicyServiceInstance", 
  "module_id": "PolicyServiceInsertion", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ByodPolicyServiceInstance"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "deployment_mode": {
      "default": "ACTIVE_STANDBY", 
      "description": "Deployment mode specifies how the partner appliance will be deployed i.e. in HA or standalone mode.", 
      "enum": [
        "STAND_ALONE", 
        "ACTIVE_STANDBY"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "Deployment Mode", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "partner_service_name": {
      "description": "Unique name of Partner Service in the Marketplace", 
      "required": true, 
      "title": "Name of Partner Service", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "transport_type": {
      "default": "L2_BRIDGE", 
      "description": "Transport to be used while deploying Service-VM.", 
      "enum": [
        "L2_BRIDGE", 
        "L3_ROUTED"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "Transport Type", 
      "type": "string"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Represents instance of self wiring partner's service", 
  "type": "object"
}

CCPUpgradeStatus (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ComponentUpgradeStatus
  }, 
  "id": "CCPUpgradeStatus", 
  "module_id": "Upgrade", 
  "properties": {
    "can_skip": {
      "readonly": true, 
      "required": false, 
      "title": "Can the upgrade of the remaining units in this component be skipped", 
      "type": "boolean"
    }, 
    "component_type": {
      "readonly": true, 
      "required": false, 
      "title": "Component type for the upgrade status", 
      "type": "string"
    }, 
    "current_version_node_summary": {
      "$ref": "NodeSummaryList, 
      "readonly": true, 
      "required": false, 
      "title": "Mapping of current versions of nodes and counts of nodes at the respective versions."
    }, 
    "details": {
      "readonly": true, 
      "required": false, 
      "title": "Details about the upgrade status", 
      "type": "string"
    }, 
    "node_count_at_target_version": {
      "description": "Number of nodes of the type and at the component version", 
      "readonly": true, 
      "required": false, 
      "title": "Count of nodes at target component version", 
      "type": "int"
    }, 
    "percent_complete": {
      "readonly": true, 
      "required": true, 
      "title": "Indicator of upgrade progress in percentage", 
      "type": "number"
    }, 
    "pre_upgrade_status": {
      "$ref": "UpgradeChecksExecutionStatus, 
      "readonly": true, 
      "required": false, 
      "title": "Pre-upgrade status of the component-type"
    }, 
    "status": {
      "enum": [
        "SUCCESS", 
        "FAILED", 
        "IN_PROGRESS", 
        "NOT_STARTED", 
        "PAUSING", 
        "PAUSED"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Upgrade status of component", 
      "type": "string"
    }, 
    "target_component_version": {
      "readonly": true, 
      "required": false, 
      "title": "Target component version", 
      "type": "string"
    }
  }, 
  "title": "Status of CCP upgrade", 
  "type": "object"
}

CentralConfigProperties (type)

{
  "id": "CentralConfigProperties", 
  "properties": {
    "local_override": {
      "required": true, 
      "title": "Override Central Config", 
      "type": "boolean"
    }
  }, 
  "title": "Central Config properties", 
  "type": "object"
}

Certificate (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "Certificate", 
  "module_id": "CertificateManager", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "details": {
      "description": "List of X509Certificates.", 
      "items": {
        "$ref": "X509Certificate
      }, 
      "readonly": true, 
      "required": false, 
      "type": "array"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "pem_encoded": {
      "description": "PEM encoded certificate data.", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "used_by": {
      "description": "List of node IDs with services, that are using this certificate.", 
      "items": {
        "$ref": "NodeIdServicesMap
      }, 
      "readonly": true, 
      "required": false, 
      "type": "array"
    }
  }, 
  "type": "object"
}

CertificateId (type)

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

ChildBfdProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for BfdProfile, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildBfdProfile", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildBfdProfile"
  }, 
  "properties": {
    "BfdProfile": {
      "$ref": "BfdProfile, 
      "description": "Contains the actual BfdProfile object.", 
      "required": true, 
      "title": "Bfd Profile"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for BfdProfile", 
  "type": "object"
}

ChildBgpNeighborConfig (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for BgpNeighborConfig, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildBgpNeighborConfig", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildBgpNeighborConfig"
  }, 
  "properties": {
    "BgpNeighborConfig": {
      "$ref": "BgpNeighborConfig, 
      "description": "Contains the actual BgpNeighborConfig object.", 
      "required": true, 
      "title": "BgpNeighborConfig"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for BgpNeighborConfig", 
  "type": "object"
}

ChildBgpRoutingConfig (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for BgpRoutingConfig, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildBgpRoutingConfig", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildBgpRoutingConfig"
  }, 
  "properties": {
    "BgpRoutingConfig": {
      "$ref": "BgpRoutingConfig, 
      "description": "Contains the actual BgpRoutingConfig object.", 
      "required": true, 
      "title": "BgpRoutingConfig"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for BgpRoutingConfig", 
  "type": "object"
}

ChildByodPolicyServiceInstance (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for ByodPolicyServiceInstance used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildByodPolicyServiceInstance", 
  "module_id": "PolicyServiceInsertion", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildByodPolicyServiceInstance"
  }, 
  "properties": {
    "ByodPolicyServiceInstance": {
      "$ref": "ByodPolicyServiceInstance, 
      "description": "Contains actual ByodPolicyServiceInstance.", 
      "required": true, 
      "title": "ByodPolicyServiceInstance"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for ByodPolicyServiceInstance", 
  "type": "object"
}

ChildCommunicationEntry (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "Child wrapper object for CommunicationEntry, used in hierarchical API This type is deprecated. Use the type ChildRule instead.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildCommunicationEntry", 
  "module_id": "Policy", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildCommunicationEntry"
  }, 
  "properties": {
    "CommunicationEntry": {
      "$ref": "CommunicationEntry, 
      "description": "Contains the actual CommunicationEntry object.", 
      "required": true, 
      "title": "CommunicationEntry"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for CommunicationEntry", 
  "type": "object"
}

ChildCommunicationMap (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "Child wrapper object for CommunicationMap, used in hierarchical API This type is deprecated. Use the type ChildSecurityPolicy instead.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildCommunicationMap", 
  "module_id": "Policy", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildCommunicationMap"
  }, 
  "properties": {
    "CommunicationMap": {
      "$ref": "CommunicationMap, 
      "description": "Contains the actual CommunicationMap object.", 
      "required": true, 
      "title": "CommunicationMap"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for CommunicationMap", 
  "type": "object"
}

ChildCommunityList (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for CommunityList, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildCommunityList", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildCommunityList"
  }, 
  "properties": {
    "CommunityList": {
      "$ref": "CommunityList, 
      "description": "Contains the actual CommunityList object", 
      "required": true, 
      "title": "CommunityList"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for CommunityList", 
  "type": "object"
}

ChildComputeClusterIdfwConfiguration (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildComputeClusterIdfwConfiguration", 
  "module_id": "PolicyFirewallConfiguration", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildComputeClusterIdfwConfiguration"
  }, 
  "properties": {
    "ComputeClusterIdfwConfiguration": {
      "$ref": "ComputeClusterIdfwConfiguration, 
      "description": "Contains the actual compute cluster idfw configuration object.", 
      "required": true, 
      "title": "ComputeClusterIdfwConfiguration"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for ComputeClusterIdfwConfiguration", 
  "type": "object"
}

ChildConstraint (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for Constraint, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildConstraint", 
  "module_id": "PolicyConstraints", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildConstraint"
  }, 
  "properties": {
    "Constraint": {
      "$ref": "Constraint, 
      "description": "Contains the actual Constraint object", 
      "required": true, 
      "title": "Constraint"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for Constraint", 
  "type": "object"
}

ChildDeploymentZone (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "Child wrapper object for DeploymentZone, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildDeploymentZone", 
  "module_id": "PolicyEnforcementPointManagement", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildDeploymentZone"
  }, 
  "properties": {
    "DeploymentZone": {
      "$ref": "DeploymentZone, 
      "description": "Contains the actual DeploymentZone object", 
      "required": true, 
      "title": "DeploymentZone"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for DeploymentZone", 
  "type": "object"
}

ChildDfwFirewallConfiguration (type)

{
  "additionalProperties": false, 
  "experimental": true, 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildDfwFirewallConfiguration", 
  "module_id": "Policy", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildDfwFirewallConfiguration"
  }, 
  "properties": {
    "DfwFirewallConfiguration": {
      "$ref": "DfwFirewallConfiguration, 
      "description": "Contains the actual dfw firewall configuration list object.", 
      "required": true, 
      "title": "Dfw Firewall Configuration"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for FirewallConfiguration", 
  "type": "object"
}

ChildDhcpRelayConfig (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for DhcpRelayConfig, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildDhcpRelayConfig", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildDhcpRelayConfig"
  }, 
  "properties": {
    "DhcpRelayConfig": {
      "$ref": "DhcpRelayConfig, 
      "description": "Contains the actual DhcpRelayConfig object", 
      "required": true, 
      "title": "DhcpRelayConfig"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for DhcpRelayConfig", 
  "type": "object"
}

ChildDhcpServerConfig (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for DhcpServerConfig, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildDhcpServerConfig", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildDhcpServerConfig"
  }, 
  "properties": {
    "DhcpServerConfig": {
      "$ref": "DhcpServerConfig, 
      "description": "Contains the actual DhcpServerConfig object", 
      "required": true, 
      "title": "DhcpServerConfig"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for DhcpServerConfig", 
  "type": "object"
}

ChildDhcpStaticBindingConfig (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for DhcpStaticBindingConfig, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildDhcpStaticBindingConfig", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildDhcpStaticBindingConfig"
  }, 
  "properties": {
    "DhcpStaticBindingConfig": {
      "$ref": "DhcpStaticBindingConfig, 
      "description": "Contains the actual DhcpStaticBindingConfig object.", 
      "required": true, 
      "title": "DhcpStaticBindingConfig"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for DhcpStaticBindingConfig", 
  "type": "object"
}

ChildDnsSecurityProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for DnsSecurityProfile, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildDnsSecurityProfile", 
  "module_id": "PolicyProfile", 
  "properties": {
    "DnsSecurityProfile": {
      "$ref": "DnsSecurityProfile, 
      "description": "Contains the actual DnsSecurityProfile object", 
      "required": true, 
      "title": "DnsSecurityProfile"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for DnsSecurityProfile", 
  "type": "object"
}

ChildDnsSecurityProfileBindingMap (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper obejct for DnsSecurityProfileBindingMap used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildDnsSecurityProfileBindingMap", 
  "module_id": "PolicyFirewallDnsSecurityProfileBinding", 
  "properties": {
    "DnsSecurityProfileBindingMap": {
      "$ref": "DnsSecurityProfileBindingMap, 
      "description": "Contains the actual DnsSecurityProfileBindingMap object", 
      "required": true, 
      "title": "DnsSecurityProfileBindingMap"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for DnsSecurityProfileBindingMap", 
  "type": "object"
}

ChildDomain (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for domain, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildDomain", 
  "module_id": "Policy", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildDomain"
  }, 
  "properties": {
    "Domain": {
      "$ref": "Domain, 
      "description": "Contains the actual domain object.", 
      "required": true, 
      "title": "Domain"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for Domain", 
  "type": "object"
}

ChildDomainDeploymentMap (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for DomainDeploymentMap, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildDomainDeploymentMap", 
  "module_id": "PolicyEnforcementPointManagement", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildDomainDeploymentMap"
  }, 
  "properties": {
    "DomainDeploymentMap": {
      "$ref": "DomainDeploymentMap, 
      "description": "Contains the actual DomainDeploymentMap object.", 
      "required": true, 
      "title": "DomainDeploymentMap"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for DomainDeploymentMap", 
  "type": "object"
}

ChildEndpointPolicy (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for EndpointPolicy used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildEndpointPolicy", 
  "module_id": "PolicyGuestIntrospection", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildEndpointPolicy"
  }, 
  "properties": {
    "EndpointPolicy": {
      "$ref": "EndpointPolicy, 
      "description": "Contains actual EndpointPolicy.", 
      "required": true, 
      "title": "EndpointPolicy"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for Endpoint Policy", 
  "type": "object"
}

ChildEndpointRule (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for EndpointRule used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildEndpointRule", 
  "module_id": "PolicyGuestIntrospection", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildEndpointRule"
  }, 
  "properties": {
    "EndpointRule": {
      "$ref": "EndpointRule, 
      "description": "Contains actual EndpointRule.", 
      "required": true, 
      "title": "EndpointRule"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for Endpoint Rule", 
  "type": "object"
}

ChildEnforcementPoint (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for EnforcementPoint, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildEnforcementPoint", 
  "module_id": "PolicyEnforcementPointManagement", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildEnforcementPoint"
  }, 
  "properties": {
    "EnforcementPoint": {
      "$ref": "EnforcementPoint, 
      "description": "Contains the actual Enforcement point object.", 
      "required": true, 
      "title": "EnforcementPoint"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for EnforcementPoint", 
  "type": "object"
}

ChildEvpnConfig (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for EvpnConfig, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildEvpnConfig", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildEvpnConfig"
  }, 
  "properties": {
    "EvpnConfig": {
      "$ref": "EvpnConfig, 
      "description": "Contains the actual EvpnConfig object.", 
      "required": true, 
      "title": "EvpnConfig"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for EvpnConfig", 
  "type": "object"
}

ChildEvpnTunnelEndpointConfig (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for EvpnTunnelEndpointConfig, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildEvpnTunnelEndpointConfig", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildEvpnTunnelEndpointConfig"
  }, 
  "properties": {
    "EvpnTunnelEndpointConfig": {
      "$ref": "EvpnTunnelEndpointConfig, 
      "description": "Contains the actual EvpnTunnelEndpointConfig object.", 
      "required": true, 
      "title": "EvpnTunnelEndpointConfig"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for EvpnTunnelEndpointConfig", 
  "type": "object"
}

ChildFloodProtectionProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for FloodProtectionProfile, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildFloodProtectionProfile", 
  "module_id": "PolicyProfile", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildFloodProtectionProfile"
  }, 
  "properties": {
    "FloodProtectionProfile": {
      "$ref": "FloodProtectionProfile, 
      "description": "Contains the actual FloodProtectionProfile object", 
      "required": true, 
      "title": "FloodProtectionProfile"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for FloodProtectionProfile", 
  "type": "object"
}

ChildFloodProtectionProfileBindingMap (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for FloodProtectionProfileBindingMap, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildFloodProtectionProfileBindingMap", 
  "module_id": "PolicyProfile", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildFloodProtectionProfileBindingMap"
  }, 
  "properties": {
    "FloodProtectionProfileBindingMap": {
      "$ref": "FloodProtectionProfileBindingMap, 
      "description": "Contains the actual FloodProtectionProfileBindingMap object", 
      "required": true, 
      "title": "FloodProtectionProfileBindingMap"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for FloodProtectionProfileBindingMap", 
  "type": "object"
}

ChildForwardingPolicy (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for ForwardingPolicy used in Hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildForwardingPolicy", 
  "module_id": "PolicyForwarding", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildForwardingPolicy"
  }, 
  "properties": {
    "ForwardingPolicy": {
      "$ref": "ForwardingPolicy, 
      "description": "Contains actual ForwardingPolicy.", 
      "required": true, 
      "title": "ForwardingPolicy"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for children of type ForwardingPolicy\n", 
  "type": "object"
}

ChildForwardingRule (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for ForwardingRule used in Hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildForwardingRule", 
  "module_id": "PolicyForwarding", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildForwardingRule"
  }, 
  "properties": {
    "ForwardingRule": {
      "$ref": "ForwardingRule, 
      "description": "Contains actual ForwardingRule.", 
      "required": true, 
      "title": "ForwardingRule"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for ForwardingRule\n", 
  "type": "object"
}

ChildFqdnAnalysisConfig (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for FqdnAnalysisConfig, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildFqdnAnalysisConfig", 
  "module_id": "PolicyUrlCategorization", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildFqdnAnalysisConfig"
  }, 
  "properties": {
    "FqdnAnalysisConfig": {
      "$ref": "FqdnAnalysisConfig, 
      "description": "Contains the actual FqdnAnalysisConfig object", 
      "required": true, 
      "title": "FQDN Analysis Config"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for FqdnAnalysisConfig", 
  "type": "object"
}

ChildGatewayPolicy (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for GatewayPolicy, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildGatewayPolicy", 
  "module_id": "Policy", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildGatewayPolicy"
  }, 
  "properties": {
    "GatewayPolicy": {
      "$ref": "GatewayPolicy, 
      "description": "Contains the actual GatewayPolicy object", 
      "required": true, 
      "title": "GatewayPolicy"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for GatewayPolicy", 
  "type": "object"
}

ChildGatewayQosProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for GatewayQosProfile, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildGatewayQosProfile", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildGatewayQosProfile"
  }, 
  "properties": {
    "QosProfile": {
      "$ref": "GatewayQosProfile, 
      "description": "Contains the actual GatewayQosProfile object.", 
      "required": true, 
      "title": "GatewayQosProfile"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for GatewayQosProfile", 
  "type": "object"
}

ChildGeneralSecurityProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for GeneralSecurityProfile, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildGeneralSecurityProfile", 
  "module_id": "PolicyProfile", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildGeneralSecurityProfile"
  }, 
  "properties": {
    "GeneralSecurityProfile": {
      "$ref": "GeneralSecurityProfile, 
      "description": "Contains the actual GeneralSecurityProfile object", 
      "required": true, 
      "title": "GeneralSecurityProfile"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for GeneralSecurityProfile", 
  "type": "object"
}

ChildGeneralSecurityProfileBindingMap (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for GeneralSecurityProfileBindingMap, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildGeneralSecurityProfileBindingMap", 
  "module_id": "PolicyProfile", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildGeneralSecurityProfileBindingMap"
  }, 
  "properties": {
    "GeneralSecurityProfileBindingMap": {
      "$ref": "GeneralSecurityProfileBindingMap, 
      "description": "Contains the actual GeneralSecurityProfileBindingMap object", 
      "required": true, 
      "title": "GeneralSecurityProfileBindingMap"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for GeneralSecurityProfileBindingMap", 
  "type": "object"
}

ChildGlobalConfig (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for GlobalConfig, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildGlobalConfig", 
  "module_id": "Policy", 
  "properties": {
    "GlobalConfig": {
      "$ref": "GlobalConfig, 
      "description": "Contains the actual GlobalConfig object.", 
      "required": true, 
      "title": "GlobalConfig"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for GlobalConfig", 
  "type": "object"
}

ChildGlobalIdsSignature (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for GlobalIdsSignature, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildGlobalIdsSignature", 
  "module_id": "PolicyIDS", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildGlobalIdsSignature"
  }, 
  "properties": {
    "GlobalIdsSignature": {
      "$ref": "GlobalIdsSignature, 
      "description": "Contains the GlobalIdsSignature object", 
      "required": true, 
      "title": "GlobalIdsSignature"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for GlobalIdsSignature", 
  "type": "object"
}

ChildGlobalManager (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for Global Manager, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildGlobalManager", 
  "module_id": "PolicySiteGM", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildGlobalManager"
  }, 
  "properties": {
    "GlobalManager": {
      "$ref": "GlobalManager, 
      "description": "Contains the actual Global Manager object.", 
      "required": true, 
      "title": "GlobalManager"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for Global Manager", 
  "type": "object"
}

ChildGroup (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for group, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildGroup", 
  "module_id": "Policy", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildGroup"
  }, 
  "properties": {
    "Group": {
      "$ref": "Group, 
      "description": "Contains the actual group objects.", 
      "required": true, 
      "title": "Group"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for Group", 
  "type": "object"
}

ChildGroupDiscoveryProfileBindingMap (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper obejct for GroupDiscoveryProfileBindingMap used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildGroupDiscoveryProfileBindingMap", 
  "module_id": "PolicyDiscoveryProfileBinding", 
  "properties": {
    "GroupDiscoveryProfileBindingMap": {
      "$ref": "GroupDiscoveryProfileBindingMap, 
      "description": "Contains the actual GroupDiscoveryProfileBindingMap object", 
      "required": true, 
      "title": "GroupDiscoveryProfileBindingMap"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for GroupDiscoveryProfileBindingMap", 
  "type": "object"
}

ChildGroupMonitoringProfileBindingMap (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for GroupMonitoringProfileBindingMap, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildGroupMonitoringProfileBindingMap", 
  "module_id": "PolicyMonitoringProfileBinding", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildGroupMonitoringProfileBindingMap"
  }, 
  "properties": {
    "GroupMonitoringProfileBindingMap": {
      "$ref": "GroupMonitoringProfileBindingMap, 
      "description": "Contains the actual GroupMonitoringProfileBindingMap object", 
      "required": true, 
      "title": "GroupMonitoringProfileBindingMap"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for GroupMonitoringProfileBindingMap", 
  "type": "object"
}

ChildIPDiscoveryProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for IPDiscoveryProfile, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildIPDiscoveryProfile", 
  "module_id": "PolicyIpDiscovery", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildIPDiscoveryProfile"
  }, 
  "properties": {
    "IPDiscoveryProfile": {
      "$ref": "IPDiscoveryProfile, 
      "description": "Contains the actual IPDiscoveryProfile object", 
      "required": true, 
      "title": "IPDiscoveryProfile"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for IPDiscoveryProfile", 
  "type": "object"
}

ChildIPFIXDFWCollectorProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for IPFIXDFWCollectorProfile, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildIPFIXDFWCollectorProfile", 
  "module_id": "PolicyIPFIXDFW", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildIPFIXDFWCollectorProfile"
  }, 
  "properties": {
    "IPFIXDFWCollectorProfile": {
      "$ref": "IPFIXDFWCollectorProfile, 
      "description": "Contains the actual IPFIXDFWCollectorProfile object", 
      "required": true, 
      "title": "IPFIXDFWCollectorProfile"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for IPFIXDFWCollectorProfile", 
  "type": "object"
}

ChildIPFIXDFWProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for IPFIXDFWProfile, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildIPFIXDFWProfile", 
  "module_id": "PolicyIPFIXDFW", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildIPFIXDFWProfile"
  }, 
  "properties": {
    "IPFIXDFWProfile": {
      "$ref": "IPFIXDFWProfile, 
      "description": "Contains the actual IPFIXDFWProfile object", 
      "required": true, 
      "title": "IPFIXDFWProfile"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for IPFIXDFWProfile", 
  "type": "object"
}

ChildIPFIXL2CollectorProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for IPFIXL2CollectorProfile, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildIPFIXL2CollectorProfile", 
  "module_id": "PolicyIPFIXSwitch", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildIPFIXL2CollectorProfile"
  }, 
  "properties": {
    "IPFIXL2CollectorProfile": {
      "$ref": "IPFIXL2CollectorProfile, 
      "description": "Contains the actual IPFIXL2CollectorProfile object", 
      "required": true, 
      "title": "IPFIXL2CollectorProfile"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for IPFIXL2CollectorProfile", 
  "type": "object"
}

ChildIPFIXL2Profile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for IPFIXL2Profile, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildIPFIXL2Profile", 
  "module_id": "PolicyIPFIXSwitch", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildIPFIXL2Profile"
  }, 
  "properties": {
    "IPFIXL2Profile": {
      "$ref": "IPFIXL2Profile, 
      "description": "Contains the actual IPFIXL2Profile object", 
      "required": true, 
      "title": "IPFIXL2Profile"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for IPFIXL2Profile", 
  "type": "object"
}

ChildIPSecVpnDpdProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for IPSecVpnDpdProfile, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildIPSecVpnDpdProfile", 
  "module_id": "PolicyIPSecVpn", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildIPSecVpnDpdProfile"
  }, 
  "properties": {
    "IPSecVpnDpdProfile": {
      "$ref": "IPSecVpnDpdProfile, 
      "description": "Contains the actual IPSecVpnDpdProfile object.", 
      "required": true, 
      "title": "IPSecVpnDpdProfile"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for IPSecVpnDpdProfile", 
  "type": "object"
}

ChildIPSecVpnIkeProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for IPSecVpnIkeProfile, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildIPSecVpnIkeProfile", 
  "module_id": "PolicyIPSecVpn", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildIPSecVpnIkeProfile"
  }, 
  "properties": {
    "IPSecVpnIkeProfile": {
      "$ref": "IPSecVpnIkeProfile, 
      "description": "Contains the actual IPSecVpnIkeProfile object.", 
      "required": true, 
      "title": "IPSecVpnIkeProfile"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for IPSecVpnIkeProfile", 
  "type": "object"
}

ChildIPSecVpnLocalEndpoint (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for IPSecVpnLocalEndpoint, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildIPSecVpnLocalEndpoint", 
  "module_id": "PolicyIPSecVpn", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildIPSecVpnLocalEndpoint"
  }, 
  "properties": {
    "IPSecVpnLocalEndpoint": {
      "$ref": "IPSecVpnLocalEndpoint, 
      "description": "Contains the actual IPSecVpnLocalEndpoint object.", 
      "required": true, 
      "title": "IPSecVpnLocalEndpoint"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for IPSecVpnLocalEndpoint", 
  "type": "object"
}

ChildIPSecVpnService (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for IPSecVpnService, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildIPSecVpnService", 
  "module_id": "PolicyIPSecVpn", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildIPSecVpnService"
  }, 
  "properties": {
    "IPSecVpnService": {
      "$ref": "IPSecVpnService, 
      "description": "Contains the actual IPSecVpnService object.", 
      "required": true, 
      "title": "IPSecVpnService"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for IPSecVpnService", 
  "type": "object"
}

ChildIPSecVpnSession (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for IPSecVpnSession, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildIPSecVpnSession", 
  "module_id": "PolicyIPSecVpn", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildIPSecVpnSession"
  }, 
  "properties": {
    "IPSecVpnSession": {
      "$ref": "IPSecVpnSession, 
      "description": "Contains the actual IPSecVpnSession object.", 
      "required": true, 
      "title": "IPSecVpnSession"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for IPSecVpnSession", 
  "type": "object"
}

ChildIPSecVpnTunnelProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for IPSecVpnTunnelProfile, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildIPSecVpnTunnelProfile", 
  "module_id": "PolicyIPSecVpn", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildIPSecVpnTunnelProfile"
  }, 
  "properties": {
    "IPSecVpnTunnelProfile": {
      "$ref": "IPSecVpnTunnelProfile, 
      "description": "Contains the actual IPSecVpnTunnelProfile object", 
      "required": true, 
      "title": "IPSecVpnTunnelProfile"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for IPSecVpnTunnelProfile", 
  "type": "object"
}

ChildIdsClusterConfig (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for IdsClusterConfig, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildIdsClusterConfig", 
  "module_id": "PolicyIDS", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildIdsClusterConfig"
  }, 
  "properties": {
    "IdsClusterConfig": {
      "$ref": "IdsClusterConfig, 
      "description": "Contains the IdsClusterConfig object", 
      "required": true, 
      "title": "IdsClusterConfig"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for IdsClusterConfig", 
  "type": "object"
}

ChildIdsProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for IdsProfile, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildIdsProfile", 
  "module_id": "PolicyIDS", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildIdsProfile"
  }, 
  "properties": {
    "IdsProfile": {
      "$ref": "IdsProfile, 
      "description": "Contains the IdsProfile object", 
      "required": true, 
      "title": "IdsProfile"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for IdsProfile", 
  "type": "object"
}

ChildIdsRule (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for IdsRule, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildIdsRule", 
  "module_id": "PolicyIDS", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildIdsRule"
  }, 
  "properties": {
    "IdsRule": {
      "$ref": "IdsRule, 
      "description": "Contains the IdsRule object", 
      "required": true, 
      "title": "IdsRule"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for IdsRule", 
  "type": "object"
}

ChildIdsSecurityPolicy (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for IdsSecurityPolicy, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildIdsSecurityPolicy", 
  "module_id": "PolicyIDS", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildIdsSecurityPolicy"
  }, 
  "properties": {
    "IdsSecurityPolicy": {
      "$ref": "IdsSecurityPolicy, 
      "description": "Contains the IdsSecurityPolicy object", 
      "required": true, 
      "title": "IdsSecurityPolicy"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for IdsSecurityPolicy", 
  "type": "object"
}

ChildIdsSettings (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for IdsSettings, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildIdsSettings", 
  "module_id": "PolicyIDS", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildIdsSettings"
  }, 
  "properties": {
    "IdsSettings": {
      "$ref": "IdsSettings, 
      "description": "Contains the IdsSettings object", 
      "required": true, 
      "title": "IdsSettings"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for IdsSettings", 
  "type": "object"
}

ChildIdsSignature (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for IdsSignature, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildIdsSignature", 
  "module_id": "PolicyIDS", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildIdsSignature"
  }, 
  "properties": {
    "IdsSignature": {
      "$ref": "IdsSignature, 
      "description": "Contains the IdsSignature object", 
      "required": true, 
      "title": "IdsSignature"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for IdsSignature", 
  "type": "object"
}

ChildIdsSignatureStatus (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for IdsSignatureStatus, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildIdsSignatureStatus", 
  "module_id": "PolicyIDS", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildIdsSignatureStatus"
  }, 
  "properties": {
    "IdsSignatureStatus": {
      "$ref": "IdsSignatureStatus, 
      "description": "Contains the IdsSignatureStatus object", 
      "required": true, 
      "title": "IdsSignatureStatus"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for IdsSignatureStatus", 
  "type": "object"
}

ChildIdsStandaloneHostConfig (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for IdsStandaloneHostConfig, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildIdsStandaloneHostConfig", 
  "module_id": "PolicyIDS", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildIdsStandaloneHostConfig"
  }, 
  "properties": {
    "IdsStandaloneHostConfig": {
      "$ref": "IdsStandaloneHostConfig, 
      "description": "Contains the IdsStandaloneHostConfig object", 
      "required": true, 
      "title": "IdsStandaloneHostConfig"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for IdsStandaloneHostConfig", 
  "type": "object"
}

ChildIpAddressAllocation (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for IpAddressAllocation, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildIpAddressAllocation", 
  "module_id": "PolicyIpam", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildIpAddressAllocation"
  }, 
  "properties": {
    "IpAddressAllocation": {
      "$ref": "IpAddressAllocation, 
      "description": "Contains the actual IpAddressAllocation object", 
      "required": true, 
      "title": "IpAddressAllocation"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for IpAddressAllocation", 
  "type": "object"
}

ChildIpAddressBlock (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for IpAddressBlock, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildIpAddressBlock", 
  "module_id": "PolicyIpam", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildIpAddressBlock"
  }, 
  "properties": {
    "IpAddressBlock": {
      "$ref": "IpAddressBlock, 
      "description": "Contains the actual IpAddressBlock object", 
      "required": true, 
      "title": "IpAddressBlock"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for IpAddressBlock", 
  "type": "object"
}

ChildIpAddressPool (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for IpAddressPool, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildIpAddressPool", 
  "module_id": "PolicyIpam", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildIpAddressPool"
  }, 
  "properties": {
    "IpAddressPool": {
      "$ref": "IpAddressPool, 
      "description": "Contains the actual IpAddressPool object", 
      "required": true, 
      "title": "IpAddressPool"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for IpAddressPool", 
  "type": "object"
}

ChildIpAddressPoolSubnet (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for IpAddressPoolSubnet, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildIpAddressPoolSubnet", 
  "module_id": "PolicyIpam", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildIpAddressPoolSubnet"
  }, 
  "properties": {
    "IpAddressPoolSubnet": {
      "$ref": "IpAddressPoolSubnet, 
      "description": "Contains the actual IpAddressPoolSubnet object", 
      "required": true, 
      "title": "IpAddressPoolSubnet"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for IpAddressPoolSubnet", 
  "type": "object"
}

ChildIpv6DadProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for Ipv6DadProfile, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildIpv6DadProfile", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "Ipv6DadProfile": {
      "$ref": "Ipv6DadProfile, 
      "description": "Contains the actual Ipv6DadProfile objects", 
      "required": true, 
      "title": "Ipv6DadProfile"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for Ipv6DadProfile", 
  "type": "object"
}

ChildIpv6NdraProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for Ipv6NdraProfile, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildIpv6NdraProfile", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "Ipv6NdraProfile": {
      "$ref": "Ipv6NdraProfile, 
      "description": "Contains the actual Ipv6NdraProfile objects", 
      "required": true, 
      "title": "Ipv6NdraProfile"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for Ipv6NdraProfile", 
  "type": "object"
}

ChildL2BridgeEndpointProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for L2BridgeEndpointProfile, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildL2BridgeEndpointProfile", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "L2BridgeEndpointProfile": {
      "$ref": "L2BridgeEndpointProfile, 
      "description": "Contains the actual L2BridgeEndpointProfile object", 
      "required": true, 
      "title": "L2BridgeEndpointProfile"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for L2BridgeEndpointProfile", 
  "type": "object"
}

ChildL2VPNService (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for L2VPNService, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildL2VPNService", 
  "module_id": "PolicyLayer2VPN", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildL2VPNService"
  }, 
  "properties": {
    "L2VPNService": {
      "$ref": "L2VPNService, 
      "description": "Contains the actual L2VPNService object.", 
      "required": true, 
      "title": "L2VPNService"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for L2VPNService", 
  "type": "object"
}

ChildL2VPNSession (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for L2VPNSession, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildL2VPNSession", 
  "module_id": "PolicyLayer2VPN", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildL2VPNSession"
  }, 
  "properties": {
    "L2VPNSession": {
      "$ref": "L2VPNSession, 
      "description": "Contains the actual L2VPNSession object.", 
      "required": true, 
      "title": "L2VPNSession"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for L2VPNSession", 
  "type": "object"
}

ChildL2Vpn (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "Child wrapper object for L2Vpn, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildL2Vpn", 
  "module_id": "PolicyL2Vpn", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildL2Vpn"
  }, 
  "properties": {
    "L2Vpn": {
      "$ref": "L2Vpn, 
      "description": "Contains the actual L2Vpn object.", 
      "required": true, 
      "title": "L2Vpn"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for L2Vpn", 
  "type": "object"
}

ChildL2VpnContext (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "Child wrapper object for L2VpnContext, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildL2VpnContext", 
  "module_id": "PolicyL2Vpn", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildL2VpnContext"
  }, 
  "properties": {
    "L2VpnContext": {
      "$ref": "L2VpnContext, 
      "description": "Contains the actual L2VpnContext object.", 
      "required": true, 
      "title": "L2VpnContext"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for L2VpnContext", 
  "type": "object"
}

ChildL3Vpn (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "Child wrapper object for L3Vpn, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildL3Vpn", 
  "module_id": "PolicyL3Vpn", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildL3Vpn"
  }, 
  "properties": {
    "L3Vpn": {
      "$ref": "L3Vpn, 
      "description": "Contains the actual L3Vpn object.", 
      "required": true, 
      "title": "L3Vpn"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for L3Vpn", 
  "type": "object"
}

ChildL3VpnContext (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "Child wrapper object for L3VpnContext, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildL3VpnContext", 
  "module_id": "PolicyL3Vpn", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildL3VpnContext"
  }, 
  "properties": {
    "L3VpnContext": {
      "$ref": "L3VpnContext, 
      "description": "Contains the actual L3VpnContext object.", 
      "required": true, 
      "title": "L3VpnContext"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for L3VpnContext", 
  "type": "object"
}

ChildLBAppProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for LBAppProfile, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildLBAppProfile", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildLBAppProfile"
  }, 
  "properties": {
    "LBAppProfile": {
      "$ref": "LBAppProfile, 
      "description": "Contains the actual LBAppProfile object.", 
      "required": true, 
      "title": "LBAppProfile"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for LBAppProfile", 
  "type": "object"
}

ChildLBClientSslProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for LBClientSslProfile, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildLBClientSslProfile", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildLBClientSslProfile"
  }, 
  "properties": {
    "LBClientSslProfile": {
      "$ref": "LBClientSslProfile, 
      "description": "Contains the actual LBClientSslProfile object.", 
      "required": true, 
      "title": "LBClientSslProfile"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for LBClientSslProfile", 
  "type": "object"
}

ChildLBMonitorProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for LBMonitorProfile, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildLBMonitorProfile", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildLBMonitorProfile"
  }, 
  "properties": {
    "LBMonitorProfile": {
      "$ref": "LBMonitorProfile, 
      "description": "Contains the actual LBMonitorProfile object.", 
      "required": true, 
      "title": "LBMonitorProfile"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for LBMonitorProfile", 
  "type": "object"
}

ChildLBPersistenceProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for LBPersistenceProfile, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildLBPersistenceProfile", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildLBPersistenceProfile"
  }, 
  "properties": {
    "LBPersistenceProfile": {
      "$ref": "LBPersistenceProfile, 
      "description": "Contains the actual LBPersistenceProfile object.", 
      "required": true, 
      "title": "LBPersistenceProfile"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for LBPersistenceProfile", 
  "type": "object"
}

ChildLBPool (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for LBPool, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildLBPool", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildLBPool"
  }, 
  "properties": {
    "LBPool": {
      "$ref": "LBPool, 
      "description": "Contains the actual LBPool object.", 
      "required": true, 
      "title": "LBPool"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for LBPool", 
  "type": "object"
}

ChildLBServerSslProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for LBServerSslProfile, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildLBServerSslProfile", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildLBServerSslProfile"
  }, 
  "properties": {
    "LBServerSslProfile": {
      "$ref": "LBServerSslProfile, 
      "description": "Contains the actual LBServerSslProfile object.", 
      "required": true, 
      "title": "LBServerSslProfile"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for LBServerSslProfile", 
  "type": "object"
}

ChildLBService (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for LBService, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildLBService", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildLBService"
  }, 
  "properties": {
    "LBService": {
      "$ref": "LBService, 
      "description": "Contains the actual LBService object.", 
      "required": true, 
      "title": "LBService"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for LBService", 
  "type": "object"
}

ChildLBVirtualServer (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for LBVirtualServer, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildLBVirtualServer", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildLBVirtualServer"
  }, 
  "properties": {
    "LBVirtualServer": {
      "$ref": "LBVirtualServer, 
      "description": "Contains the actual LBVirtualServer object.", 
      "required": true, 
      "title": "LBVirtualServer"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for LBVirtualServer", 
  "type": "object"
}

ChildLiveTraceConfig (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for LiveTraceConfig for Hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildLiveTraceConfig", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildLiveTraceConfig"
  }, 
  "properties": {
    "LiveTraceConfig": {
      "$ref": "LiveTraceConfig, 
      "description": "The actual LiveTraceConfig object.", 
      "required": true, 
      "title": "LiveTraceConfig"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for LiveTraceConfig", 
  "type": "object"
}

ChildLocaleServices (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for LocaleServices, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildLocaleServices", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildLocaleServices"
  }, 
  "properties": {
    "LocaleServices": {
      "$ref": "LocaleServices, 
      "description": "Contains the actual LocaleServices object", 
      "required": true, 
      "title": "LocaleServices"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for LocaleServices", 
  "type": "object"
}

ChildMacDiscoveryProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for MacDiscoveryProfile, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildMacDiscoveryProfile", 
  "module_id": "PolicyMacDiscovery", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildMacDiscoveryProfile"
  }, 
  "properties": {
    "MacDiscoveryProfile": {
      "$ref": "MacDiscoveryProfile, 
      "description": "Contains the actual MacDiscoveryProfile object", 
      "required": true, 
      "title": "MacDiscoveryProfile"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for MacDiscoveryProfile", 
  "type": "object"
}

ChildMetadataProxyConfig (type)

{
  "additionalProperties": false, 
  "descritpion": "Child wrapper object for MetadataProxyConfig, used in hierarchical APIs", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildMetadataProxyConfig", 
  "module_id": "PolicyMetadataProxy", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildMetadataProxyConfig"
  }, 
  "properties": {
    "MetadataProxyConfig": {
      "$ref": "MetadataProxyConfig, 
      "description": "Contains the actual MetadataProxyConfig object.", 
      "required": true, 
      "title": "MetadataProxyConfig"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for MetadataProxyConfig", 
  "type": "object"
}

ChildPolicyConfigResource (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "description": "Represents an object on the desired state", 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "ChildPolicyConfigResource", 
  "module_id": "Policy", 
  "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: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Represents the desired state object as child resource", 
  "type": "object"
}

ChildPolicyContextProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for PolicyContextProfile, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPolicyContextProfile", 
  "module_id": "PolicyContextProfile", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildPolicyContextProfile"
  }, 
  "properties": {
    "PolicyContextProfile": {
      "$ref": "PolicyContextProfile, 
      "description": "Contains the actual PolicyContextProfile objects", 
      "required": true, 
      "title": "PolicyContextProfile"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PolicyContextProfile", 
  "type": "object"
}

ChildPolicyDnsForwarder (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for PolicyDnsForwarder, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPolicyDnsForwarder", 
  "module_id": "PolicyDnsForwarder", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildPolicyDnsForwarder"
  }, 
  "properties": {
    "PolicyDnsForwarder": {
      "$ref": "PolicyDnsForwarder, 
      "description": "Contains the actual PolicyDnsForwarder object", 
      "required": true, 
      "title": "PolicyDnsForwarder"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PolicyDnsForwarder", 
  "type": "object"
}

ChildPolicyDnsForwarderZone (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for PolicyDnsForwarderZone, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPolicyDnsForwarderZone", 
  "module_id": "PolicyDnsForwarder", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildPolicyDnsForwarderZone"
  }, 
  "properties": {
    "PolicyDnsForwarderZone": {
      "$ref": "PolicyDnsForwarderZone, 
      "description": "Contains the actual PolicyDnsForwarderZone object", 
      "required": true, 
      "title": "PolicyDnsForwarderZone"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PolicyDnsForwarderZone", 
  "type": "object"
}

ChildPolicyEdgeCluster (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for PolicyEdgeCluster, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPolicyEdgeCluster", 
  "module_id": "PolicyEnforcementPointManagement", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildPolicyEdgeCluster"
  }, 
  "properties": {
    "PolicyEdgeCluster": {
      "$ref": "PolicyEdgeCluster, 
      "description": "Contains the actual PolicyEdgeCluster object.", 
      "required": true, 
      "title": "PolicyEdgeCluster"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PolicyEdgeCluster", 
  "type": "object"
}

ChildPolicyEdgeNode (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for PolicyEdgeNode, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPolicyEdgeNode", 
  "module_id": "PolicyEnforcementPointManagement", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildPolicyEdgeNode"
  }, 
  "properties": {
    "PolicyEdgeNode": {
      "$ref": "PolicyEdgeNode, 
      "description": "Contains the actual PolicyEdgeNode object.", 
      "required": true, 
      "title": "PolicyEdgeNode"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PolicyEdgeNode", 
  "type": "object"
}

ChildPolicyExcludeList (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPolicyExcludeList", 
  "module_id": "PolicyFirewallConfiguration", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildPolicyExcludeList"
  }, 
  "properties": {
    "PolicyExcludeList": {
      "$ref": "PolicyExcludeList, 
      "description": "Contains the actual policy exclude list object.", 
      "required": true, 
      "title": "PolicyExcludeList"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PolicyExcludeList", 
  "type": "object"
}

ChildPolicyFirewallCPUMemThresholdsProfileBindingMap (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for PolicyFirewallCPUMemThresholdsProfileBindingMap, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPolicyFirewallCPUMemThresholdsProfileBindingMap", 
  "module_id": "PolicyFirewallCPUMemThresholdsProfileBinding", 
  "properties": {
    "PolicyFirewallCPUMemThresholdsProfileBindingMap": {
      "$ref": "PolicyFirewallCPUMemThresholdsProfileBindingMap, 
      "description": "Contains the actual PolicyFirewallCPUMemThresholdsProfileBindingMap object.", 
      "required": true, 
      "title": "PolicyFirewallCPUMemThresholdsProfileBindingMap"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PolicyFirewallCPUMemThresholdsProfileBindingMap", 
  "type": "object"
}

ChildPolicyFirewallCpuMemThresholdsProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for PolicyFirewallCpuMemThresholdsProfile, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPolicyFirewallCpuMemThresholdsProfile", 
  "module_id": "PolicyProfile", 
  "properties": {
    "PolicyFirewallCpuMemThresholdsProfile": {
      "$ref": "PolicyFirewallCpuMemThresholdsProfile, 
      "description": "Contains the actual PolicyFirewallCpuMemThresholdsProfile object", 
      "required": true, 
      "title": "PolicyFirewallCpuMemThresholdsProfile"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PolicyFirewallCpuMemThresholdsProfile", 
  "type": "object"
}

ChildPolicyFirewallFloodProtectionProfileBindingMap (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for PolicyFirewallFloodProtectionProfileBindingMap, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPolicyFirewallFloodProtectionProfileBindingMap", 
  "module_id": "PolicyFirewallFloodProtectionProfileBinding", 
  "properties": {
    "PolicyFirewallFloodProtectionProfileBindingMap": {
      "$ref": "PolicyFirewallFloodProtectionProfileBindingMap, 
      "description": "Contains the actual PolicyFirewallFloodProtectionProfileBindingMap object", 
      "required": true, 
      "title": "PolicyFirewallFloodProtectionProfileBindingMap"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PolicyFirewallFloodProtectionProfileBindingMap", 
  "type": "object"
}

ChildPolicyFirewallScheduler (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for PolicyFirewallScheduler, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPolicyFirewallScheduler", 
  "module_id": "PolicyFirewallScheduler", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildPolicyFirewallScheduler"
  }, 
  "properties": {
    "PolicyFirewallScheduler": {
      "$ref": "PolicyFirewallScheduler, 
      "description": "Contains the actual PolicyFirewallScheduler objects", 
      "required": true, 
      "title": "PolicyFirewallScheduler"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PolicyFirewallScheduler", 
  "type": "object"
}

ChildPolicyFirewallSessionTimerProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for PolicyFirewallSessionTimerProfile, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPolicyFirewallSessionTimerProfile", 
  "module_id": "PolicyFirewallSessionTimerProfile", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildPolicyFirewallSessionTimerProfile"
  }, 
  "properties": {
    "PolicyFirewallSessionTimerProfile": {
      "$ref": "PolicyFirewallSessionTimerProfile, 
      "description": "Contains the actual PolicyFirewallSessionTimerProfile object", 
      "required": true, 
      "title": "PolicyFirewallSessionTimerProfile"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PolicyFirewallSessionTimerProfile", 
  "type": "object"
}

ChildPolicyFirewallSessionTimerProfileBindingMap (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for PolicyFirewallSessionTimerProfileBindingMap, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPolicyFirewallSessionTimerProfileBindingMap", 
  "module_id": "PolicyFirewallSessionTimerProfileBinding", 
  "properties": {
    "PolicyFirewallSessionTimerProfileBindingMap": {
      "$ref": "PolicyFirewallSessionTimerProfileBindingMap, 
      "description": "Contains the actual PolicyFirewallSessionTimerProfileBindingMap object", 
      "required": true, 
      "title": "PolicyFirewallSessionTimerProfileBindingMap"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PolicyFirewallSessionTimerProfileBindingMap", 
  "type": "object"
}

ChildPolicyIgmpProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for PolicyIgmpProfile used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPolicyIgmpProfile", 
  "module_id": "PolicyMulticast", 
  "properties": {
    "PolicyIgmpProfile": {
      "$ref": "PolicyIgmpProfile, 
      "description": "Contains actual PolicyIgmpProfile.", 
      "required": true, 
      "title": "PolicyIgmpProfile"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PolicyIgmpProfile", 
  "type": "object"
}

ChildPolicyLabel (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for PolicyLabel, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPolicyLabel", 
  "module_id": "PolicyLabel", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildPolicyLabel"
  }, 
  "properties": {
    "PolicyLabel": {
      "$ref": "PolicyLabel, 
      "description": "Contains the actual PolicyLabel object", 
      "required": true, 
      "title": "PolicyLabel"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PolicyLabel", 
  "type": "object"
}

ChildPolicyLbMonitorProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for PolicyLbMonitorProfile, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPolicyLbMonitorProfile", 
  "module_id": "TempPolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildPolicyLbMonitorProfile"
  }, 
  "properties": {
    "PolicyLbMonitorProfile": {
      "$ref": "PolicyLbMonitorProfile, 
      "description": "Contains the actual PolicyLbMonitorProfile object", 
      "required": true, 
      "title": "PolicyLbMonitorProfile"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PolicyLbMonitorProfile", 
  "type": "object"
}

ChildPolicyLbPersistenceProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for PolicyLbPersistenceProfile, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPolicyLbPersistenceProfile", 
  "module_id": "TempPolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildPolicyLbPersistenceProfile"
  }, 
  "properties": {
    "PolicyLbPersistenceProfile": {
      "$ref": "PolicyLbPersistenceProfile, 
      "description": "Contains the actual PolicyLbPersistenceProfile object", 
      "required": true, 
      "title": "PolicyLbPersistenceProfile"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PolicyLbPersistenceProfile", 
  "type": "object"
}

ChildPolicyLbPoolAccess (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for PolicyLbPoolAccess, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPolicyLbPoolAccess", 
  "module_id": "TempPolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildPolicyLbPoolAccess"
  }, 
  "properties": {
    "PolicyLbPoolAccess": {
      "$ref": "PolicyLbPoolAccess, 
      "description": "Contains the actual PolicyLbPoolAccess object", 
      "required": true, 
      "title": "PolicyLbPoolAccess"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PolicyLbPoolAccess", 
  "type": "object"
}

ChildPolicyLbRule (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for PolicyLbRule, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPolicyLbRule", 
  "module_id": "TempPolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildPolicyLbRule"
  }, 
  "properties": {
    "PolicyLbRule": {
      "$ref": "PolicyLbRule, 
      "description": "Contains the actual PolicyLbRule object", 
      "required": true, 
      "title": "PolicyLbRule"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PolicyLbRule", 
  "type": "object"
}

ChildPolicyLbVirtualServer (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for PolicyLbVirtualServer, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPolicyLbVirtualServer", 
  "module_id": "TempPolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildPolicyLbVirtualServer"
  }, 
  "properties": {
    "PolicyLbVirtualServer": {
      "$ref": "PolicyLbVirtualServer, 
      "description": "Contains the actual PolicyLbVirtualServer object", 
      "required": true, 
      "title": "PolicyLbVirtualServer"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PolicyLbVirtualServer", 
  "type": "object"
}

ChildPolicyMulticastConfig (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for PolicyMulticastConfig used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPolicyMulticastConfig", 
  "module_id": "PolicyMulticast", 
  "properties": {
    "PolicyMulticastConfig": {
      "$ref": "PolicyMulticastConfig, 
      "description": "Contains actual PolicyMulticastConfig.", 
      "required": true, 
      "title": "PolicyMulticastConfig"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PolicyMulticastConfig", 
  "type": "object"
}

ChildPolicyNat (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for PolicyNat, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPolicyNat", 
  "module_id": "PolicyNAT", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildPolicyNat"
  }, 
  "properties": {
    "PolicyNat": {
      "$ref": "PolicyNat, 
      "description": "Contains the actual PolicyNAT object", 
      "required": true, 
      "title": "PolicyNat"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PolicyNat", 
  "type": "object"
}

ChildPolicyNatRule (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for PolicyNatRule, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPolicyNatRule", 
  "module_id": "PolicyNAT", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildPolicyNatRule"
  }, 
  "properties": {
    "PolicyNatRule": {
      "$ref": "PolicyNatRule, 
      "description": "Contains the actual PolicyNatRule object", 
      "required": true, 
      "title": "PolicyNatRule"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PolicyNatRule", 
  "type": "object"
}

ChildPolicyPimProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for PolicyPimProfile used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPolicyPimProfile", 
  "module_id": "PolicyMulticast", 
  "properties": {
    "PolicyPimProfile": {
      "$ref": "PolicyPimProfile, 
      "description": "Contains actual PolicyPimProfile.", 
      "required": true, 
      "title": "PolicyPimProfile"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PolicyPimProfile", 
  "type": "object"
}

ChildPolicySIExcludeList (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPolicySIExcludeList", 
  "module_id": "PolicyServiceInsertion", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildPolicySIExcludeList"
  }, 
  "properties": {
    "PolicySIExcludeList": {
      "$ref": "PolicySIExcludeList, 
      "description": "Contains the actual policy exclude list object.", 
      "required": true, 
      "title": "PolicySIExcludeList"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PolicySIExcludeList", 
  "type": "object"
}

ChildPolicyServiceChain (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for PolicyServiceInstance used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPolicyServiceChain", 
  "module_id": "PolicyServiceInsertion", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildPolicyServiceChain"
  }, 
  "properties": {
    "PolicyServiceChain": {
      "$ref": "PolicyServiceChain, 
      "description": "Contains actual PolicyServiceChain.", 
      "required": true, 
      "title": "PolicyServiceChain"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PolicyServiceChain", 
  "type": "object"
}

ChildPolicyServiceInstance (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for PolicyServiceInstance used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPolicyServiceInstance", 
  "module_id": "PolicyServiceInsertion", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildPolicyServiceInstance"
  }, 
  "properties": {
    "PolicyServiceInstance": {
      "$ref": "PolicyServiceInstance, 
      "description": "Contains actual PolicyServiceInstance.", 
      "required": true, 
      "title": "PolicyServiceInstance"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PolicyServiceInstance", 
  "type": "object"
}

ChildPolicyServiceProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for PolicyServiceProfile used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPolicyServiceProfile", 
  "module_id": "PolicyServiceInsertion", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildPolicyServiceProfile"
  }, 
  "properties": {
    "PolicyServiceProfile": {
      "$ref": "PolicyServiceProfile, 
      "description": "Contains actual PolicyServiceProfile.", 
      "required": true, 
      "title": "PolicyServiceProfile"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PolicyServiceProfile", 
  "type": "object"
}

ChildPolicyTier1MulticastConfig (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for PolicyTier1MulticastConfig used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPolicyTier1MulticastConfig", 
  "module_id": "PolicyMulticast", 
  "properties": {
    "PolicyTier1MulticastConfig": {
      "$ref": "PolicyTier1MulticastConfig, 
      "description": "Contains actual PolicyTier1MulticastConfig.", 
      "required": true, 
      "title": "PolicyTier1MulticastConfig"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PolicyTier1MulticastConfig", 
  "type": "object"
}

ChildPolicyTransportZone (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for PolicyTransportZone, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPolicyTransportZone", 
  "module_id": "PolicyEnforcementPointManagement", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildPolicyTransportZone"
  }, 
  "properties": {
    "PolicyTransportZone": {
      "$ref": "PolicyTransportZone, 
      "description": "Contains the actual PolicyTransportZone object.", 
      "required": true, 
      "title": "PolicyTransportZone"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PolicyTransportZone", 
  "type": "object"
}

ChildPolicyUrlCategorizationConfig (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for PolicyUrlCategorizationConfig, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPolicyUrlCategorizationConfig", 
  "module_id": "PolicyUrlCategorization", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildPolicyUrlCategorizationConfig"
  }, 
  "properties": {
    "PolicyUrlCategorizationConfig": {
      "$ref": "PolicyUrlCategorizationConfig, 
      "description": "Contains the actual PolicyUrlCategorizationConfig object", 
      "required": true, 
      "title": "URL Categorization Config"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PolicyUrlCategorizationConfig", 
  "type": "object"
}

ChildPortDiscoveryProfileBindingMap (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for PortDiscoveryProfileBindingMap, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPortDiscoveryProfileBindingMap", 
  "module_id": "PolicyDiscoveryProfileBinding", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildPortDiscoveryProfileBindingMap"
  }, 
  "properties": {
    "PortDiscoveryProfileBindingMap": {
      "$ref": "PortDiscoveryProfileBindingMap, 
      "description": "Contains the actual PortDiscoveryProfileBindingMap object", 
      "required": true, 
      "title": "PortDiscoveryProfileBindingMap"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PortDiscoveryProfileBindingMap", 
  "type": "object"
}

ChildPortMirroringProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for PortMirroringProfile, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPortMirroringProfile", 
  "module_id": "PolicyPortMirroring", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildPortMirroringProfile"
  }, 
  "properties": {
    "PortMirroringProfile": {
      "$ref": "PortMirroringProfile, 
      "description": "Contains the actual PortMirroringProfile object", 
      "required": true, 
      "title": "PortMirroringProfile"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PortMirroringProfile", 
  "type": "object"
}

ChildPortMonitoringProfileBindingMap (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for PortMonitoringProfileBindingMap, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPortMonitoringProfileBindingMap", 
  "module_id": "PolicyMonitoringProfileBinding", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildPortMonitoringProfileBindingMap"
  }, 
  "properties": {
    "PortMonitoringProfileBindingMap": {
      "$ref": "PortMonitoringProfileBindingMap, 
      "description": "Contains the actual PortMonitoringProfileBindingMap object", 
      "required": true, 
      "title": "PortMonitoringProfileBindingMap"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PortMonitoringProfileBindingMap", 
  "type": "object"
}

ChildPortQoSProfileBindingMap (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for PortQoSProfileBindingMap, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPortQoSProfileBindingMap", 
  "module_id": "PolicyQoSProfileBinding", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildPortQoSProfileBindingMap"
  }, 
  "properties": {
    "PortQoSProfileBindingMap": {
      "$ref": "PortQoSProfileBindingMap, 
      "description": "Contains the actual PortQoSProfileBindingMap object", 
      "required": true, 
      "title": "PortQoSProfileBindingMap"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PortQoSProfileBindingMap", 
  "type": "object"
}

ChildPortSecurityProfileBindingMap (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for PortSecurityProfileBindingMap, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPortSecurityProfileBindingMap", 
  "module_id": "PolicySecurityProfileBinding", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildPortSecurityProfileBindingMap"
  }, 
  "properties": {
    "PortSecurityProfileBindingMap": {
      "$ref": "PortSecurityProfileBindingMap, 
      "description": "Contains the actual PortSecurityProfileBindingMap object", 
      "required": true, 
      "title": "PortSecurityProfileBindingMap"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PortSecurityProfileBindingMap", 
  "type": "object"
}

ChildPrefixList (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for PrefixList, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildPrefixList", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildPrefixList"
  }, 
  "properties": {
    "PrefixList": {
      "$ref": "PrefixList, 
      "description": "Contains the actual PrefixList object.", 
      "required": true, 
      "title": "PrefixList"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PrefixList", 
  "type": "object"
}

ChildQoSProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for QoSProfile, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildQoSProfile", 
  "module_id": "PolicyQoS", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildQoSProfile"
  }, 
  "properties": {
    "QoSProfile": {
      "$ref": "QoSProfile, 
      "description": "Contains the actual QoSProfile object", 
      "required": true, 
      "title": "QoSProfile"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for QoSProfile", 
  "type": "object"
}

ChildReaction (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for Reaction used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildReaction", 
  "module_id": "PolicyReaction", 
  "properties": {
    "Reaction": {
      "$ref": "Reaction, 
      "description": "Contains the actual Reaction object.", 
      "required": true, 
      "title": "Reaction"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for Reaction", 
  "type": "object"
}

ChildRedirectionPolicy (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for RedirectionPolicy used in Hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildRedirectionPolicy", 
  "module_id": "PolicyServiceInsertion", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildRedirectionPolicy"
  }, 
  "properties": {
    "RedirectionPolicy": {
      "$ref": "RedirectionPolicy, 
      "description": "Contains actual RedirectionPolicy.", 
      "required": true, 
      "title": "RedirectionPolicy"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for RedirectionPolicy\n", 
  "type": "object"
}

ChildRedirectionRule (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for ChildRedirectionRule used in Hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildRedirectionRule", 
  "module_id": "PolicyServiceInsertion", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildRedirectionRule"
  }, 
  "properties": {
    "RedirectionRule": {
      "$ref": "RedirectionRule, 
      "description": "Contains actual RedirectionRule.", 
      "required": true, 
      "title": "RedirectionRule"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for RedirectionRule\n", 
  "type": "object"
}

ChildResourceReference (type)

{
  "additionalProperties": false, 
  "description": "Represents a reference to ChildPolicyConfigResource in the hierarchical API. resource_type, id and target_type are mandatory fields.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildResourceReference", 
  "module_id": "Policy", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "target_type": {
      "required": true, 
      "title": "The target type of this reference", 
      "type": "string"
    }
  }, 
  "title": "Represents the reference to ChildPolicyConfigResource", 
  "type": "object"
}

ChildRule (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for Rule, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildRule", 
  "module_id": "Policy", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildRule"
  }, 
  "properties": {
    "Rule": {
      "$ref": "Rule, 
      "description": "Contains the actual Rule object", 
      "required": true, 
      "title": "Rule"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for Rule", 
  "type": "object"
}

ChildSIStatusConfiguration (type)

{
  "additionalProperties": false, 
  "experimental": true, 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildSIStatusConfiguration", 
  "module_id": "PolicyServiceInsertion", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildPolicySIStatusConfiguration"
  }, 
  "properties": {
    "PolicySIStatusConfiguration": {
      "$ref": "PolicySIStatusConfiguration, 
      "description": "Contains the actual service insertion status configuration list object.", 
      "required": true
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for PolicySIStatusConfiguration", 
  "type": "object"
}

ChildSecurityPolicy (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for SecurityPolicy, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildSecurityPolicy", 
  "module_id": "Policy", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildSecurityPolicy"
  }, 
  "properties": {
    "SecurityPolicy": {
      "$ref": "SecurityPolicy, 
      "description": "Contains the actual SecurityPolicy object", 
      "required": true, 
      "title": "SecurityPolicy"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for SecurityPolicy", 
  "type": "object"
}

ChildSegment (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for Segment, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildSegment", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildSegment"
  }, 
  "properties": {
    "Segment": {
      "$ref": "Segment, 
      "description": "Contains the actual Segment object.", 
      "required": true, 
      "title": "Segment"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for Segment", 
  "type": "object"
}

ChildSegmentDiscoveryProfileBindingMap (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for SegmentDiscoveryProfileBindingMap, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildSegmentDiscoveryProfileBindingMap", 
  "module_id": "PolicyDiscoveryProfileBinding", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildSegmentDiscoveryProfileBindingMap"
  }, 
  "properties": {
    "SegmentDiscoveryProfileBindingMap": {
      "$ref": "SegmentDiscoveryProfileBindingMap, 
      "description": "Contains the actual SegmentDiscoveryProfileBindingMap object", 
      "required": true, 
      "title": "SegmentDiscoveryProfileBindingMap"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for SegmentDiscoveryProfileBindingMap", 
  "type": "object"
}

ChildSegmentMonitoringProfileBindingMap (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for SegmentMonitoringProfileBindingMap, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildSegmentMonitoringProfileBindingMap", 
  "module_id": "PolicyMonitoringProfileBinding", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildSegmentMonitoringProfileBindingMap"
  }, 
  "properties": {
    "SegmentMonitoringProfileBindingMap": {
      "$ref": "SegmentMonitoringProfileBindingMap, 
      "description": "Contains the actual SegmentMonitoringProfileBindingMap object", 
      "required": true, 
      "title": "SegmentMonitoringProfileBindingMap"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for SegmentMonitoringProfileBindingMap", 
  "type": "object"
}

ChildSegmentPort (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for SegmentPort, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildSegmentPort", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildSegmentPort"
  }, 
  "properties": {
    "SegmentPort": {
      "$ref": "SegmentPort, 
      "description": "Contains the actual SegmentPort object", 
      "required": true, 
      "title": "SegmentPort"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for SegmentPort", 
  "type": "object"
}

ChildSegmentQoSProfileBindingMap (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for SegmentQoSProfileBindingMap, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildSegmentQoSProfileBindingMap", 
  "module_id": "PolicyQoSProfileBinding", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildSegmentQoSProfileBindingMap"
  }, 
  "properties": {
    "SegmentQoSProfileBindingMap": {
      "$ref": "SegmentQoSProfileBindingMap, 
      "description": "Contains the actual SegmentQoSProfileBindingMap object", 
      "required": true, 
      "title": "SegmentQoSProfileBindingMap"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for SegmentQoSProfileBindingMap", 
  "type": "object"
}

ChildSegmentSecurityProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for SegmentSecurityProfile, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildSegmentSecurityProfile", 
  "module_id": "PolicySegmentSecurity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildSegmentSecurityProfile"
  }, 
  "properties": {
    "SegmentSecurityProfile": {
      "$ref": "SegmentSecurityProfile, 
      "description": "Contains the actual SegmentSecurityProfile object", 
      "required": true, 
      "title": "SegmentSecurityProfile"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for SegmentSecurityProfile", 
  "type": "object"
}

ChildSegmentSecurityProfileBindingMap (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for SegmentSecurityProfileBindingMap, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildSegmentSecurityProfileBindingMap", 
  "module_id": "PolicySecurityProfileBinding", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildSegmentSecurityProfileBindingMap"
  }, 
  "properties": {
    "SegmentSecurityProfileBindingMap": {
      "$ref": "SegmentSecurityProfileBindingMap, 
      "description": "Contains the actual SegmentSecurityProfileBindingMap object", 
      "required": true, 
      "title": "SegmentSecurityProfileBindingMap"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for SegmentSecurityProfileBindingMap", 
  "type": "object"
}

ChildService (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for Service, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildService", 
  "module_id": "Policy", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildService"
  }, 
  "properties": {
    "Service": {
      "$ref": "Service, 
      "description": "Contains the actual Service object.", 
      "required": true, 
      "title": "Service"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for Service", 
  "type": "object"
}

ChildServiceEntry (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for ServiceEntry, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildServiceEntry", 
  "module_id": "Policy", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildServiceEntry"
  }, 
  "properties": {
    "Service": {
      "$ref": "ServiceEntry, 
      "deprecated": true, 
      "description": "This is a deprecated property, Please use 'ServiceEntry' instead.", 
      "title": "ServiceEntry"
    }, 
    "ServiceEntry": {
      "$ref": "ServiceEntry, 
      "description": "Contains the actual ServiceEntry object.", 
      "required": true, 
      "title": "ServiceEntry"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for ServiceEntry", 
  "type": "object"
}

ChildServiceInstanceEndpoint (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for ServiceInstanceEndpoint used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildServiceInstanceEndpoint", 
  "module_id": "PolicyServiceInsertion", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildServiceInstanceEndpoint"
  }, 
  "properties": {
    "ServiceInstanceEndpoint": {
      "$ref": "ServiceInstanceEndpoint, 
      "description": "Contains actual ServiceInstanceEndpoint.", 
      "required": true, 
      "title": "ServiceInstanceEndpoint"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for ServiceInstanceEndpoint", 
  "type": "object"
}

ChildServiceInterface (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for ServiceInterface, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildServiceInterface", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildServiceInterface"
  }, 
  "properties": {
    "ServiceInterface": {
      "$ref": "ServiceInterface, 
      "description": "Contains the actual ServiceInterface object.", 
      "required": true, 
      "title": "ServiceInterface"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for ServiceInterface", 
  "type": "object"
}

ChildServiceReference (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for ServiceReference used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildServiceReference", 
  "module_id": "PolicyServiceInsertion", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildServiceReference"
  }, 
  "properties": {
    "ServiceReference": {
      "$ref": "ServiceReference, 
      "description": "Contains actual ServiceReference.", 
      "required": true, 
      "title": "ServiceReference"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for ServiceReference", 
  "type": "object"
}

ChildServiceSegment (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for ServiceSegment, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildServiceSegment", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildServiceSegment"
  }, 
  "properties": {
    "ServiceSegment": {
      "$ref": "ServiceSegment, 
      "description": "Contains the actual ServiceSegment objects", 
      "required": true, 
      "title": "ServiceSegments"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for SerivceSegment", 
  "type": "object"
}

ChildSessionTimerProfileBindingMap (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for SessionTimerProfileBindingMap, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildSessionTimerProfileBindingMap", 
  "module_id": "PolicyProfile", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildSessionTimerProfileBindingMap"
  }, 
  "properties": {
    "SessionTimerProfileBindingMap": {
      "$ref": "SessionTimerProfileBindingMap, 
      "description": "Contains the actual SessionTimerProfileBindingMap object", 
      "required": true, 
      "title": "SessionTimerProfileBindingMap"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for SessionTimerProfileBindingMap", 
  "type": "object"
}

ChildSite (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for Site, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildSite", 
  "module_id": "PolicyEnforcementPointManagement", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildSite"
  }, 
  "properties": {
    "Site": {
      "$ref": "Site, 
      "description": "Contains the actual Site object.", 
      "required": true, 
      "title": "Site"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for Site", 
  "type": "object"
}

ChildSpoofGuardProfile (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for SpoofGuardProfile, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildSpoofGuardProfile", 
  "module_id": "PolicySpoofGuard", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildSpoofGuardProfile"
  }, 
  "properties": {
    "SpoofGuardProfile": {
      "$ref": "SpoofGuardProfile, 
      "description": "Contains the actual SpoofGuardProfile object", 
      "required": true, 
      "title": "SpoofGuardProfile"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for SpoofGuardProfile", 
  "type": "object"
}

ChildSslTrustObjectData (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for SslTrustObjectData, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildSslTrustObjectData", 
  "module_id": "TempPolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildSslTrustObjectData"
  }, 
  "properties": {
    "SslTrustObjectData": {
      "$ref": "SslTrustObjectData, 
      "description": "Contains the actual SslTrustObjectData object", 
      "required": true, 
      "title": "SslTrustObjectData"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for SslTrustObjectData", 
  "type": "object"
}

ChildStandaloneHostIdfwConfiguration (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildStandaloneHostIdfwConfiguration", 
  "module_id": "PolicyFirewallConfiguration", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildStandaloneHostIdfwConfiguration"
  }, 
  "properties": {
    "StandaloneHostIdfwConfiguration": {
      "$ref": "StandaloneHostIdfwConfiguration, 
      "description": "Contains the actual standalone host idfw configuration object.", 
      "required": true, 
      "title": "StandaloneHostIdfwConfiguration"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for StandaloneHostIdfwConfiguration", 
  "type": "object"
}

ChildStaticARPConfig (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for StaticARPConfig, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildStaticARPConfig", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildStaticARPConfig"
  }, 
  "properties": {
    "StaticARPConfig": {
      "$ref": "StaticARPConfig, 
      "description": "Contains the actual StaticARPConfig object.", 
      "required": true, 
      "title": "StaticARPConfig"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for StaticARPConfig", 
  "type": "object"
}

ChildStaticRouteBfdPeer (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for StaticRouteBfdPeer, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildStaticRouteBfdPeer", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildStaticRouteBfdPeer"
  }, 
  "properties": {
    "BfdPeer": {
      "$ref": "StaticRouteBfdPeer, 
      "description": "Contains the actual StaticRouteBfdPeer object.", 
      "required": true, 
      "title": "Static Route BFD Peer"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for StaticRouteBfdPeer", 
  "type": "object"
}

ChildStaticRoutes (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for StaticRoutes, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildStaticRoutes", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildStaticRoutes"
  }, 
  "properties": {
    "StaticRoutes": {
      "$ref": "StaticRoutes, 
      "description": "Contains the actual StaticRoutes object.", 
      "required": true, 
      "title": "StaticRoutes"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for StaticRoutes", 
  "type": "object"
}

ChildTier0 (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for Tier-0, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildTier0", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildTier0"
  }, 
  "properties": {
    "Tier0": {
      "$ref": "Tier0, 
      "description": "Contains the actual Tier-0 object.", 
      "required": true, 
      "title": "Tier-0"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for Tier-0", 
  "type": "object"
}

ChildTier0DeploymentMap (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for Tier0DeploymentMap, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildTier0DeploymentMap", 
  "module_id": "PolicyEnforcementPointManagement", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildTier0DeploymentMap"
  }, 
  "properties": {
    "Tier0DeploymentMap": {
      "$ref": "Tier0DeploymentMap, 
      "description": "Contains the actual Tier0DeploymentMap object.", 
      "required": true, 
      "title": "Tier0DeploymentMap"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for Tier0DeploymentMap", 
  "type": "object"
}

ChildTier0Interface (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for Tier0Interface, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildTier0Interface", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildTier0Interface"
  }, 
  "properties": {
    "Tier0Interface": {
      "$ref": "Tier0Interface, 
      "description": "Contains the actual Tier0Interface object.", 
      "required": true, 
      "title": "Tier0Interface"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for Tier0Interface", 
  "type": "object"
}

ChildTier0RouteMap (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for Tier0RouteMap, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildTier0RouteMap", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildTier0RouteMap"
  }, 
  "properties": {
    "Tier0RouteMap": {
      "$ref": "Tier0RouteMap, 
      "description": "Contains the actual Tier0RouteMap object", 
      "required": true, 
      "title": "Tier0RouteMap"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for Tier0RouteMap", 
  "type": "object"
}

ChildTier1 (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for Tier-1 , used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildTier1", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildTier1"
  }, 
  "properties": {
    "Tier1": {
      "$ref": "Tier1, 
      "description": "Contains the actual Tier-1 object.", 
      "required": true, 
      "title": "Tier-1"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for Tier-1", 
  "type": "object"
}

ChildTier1DeploymentMap (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for Tier1DeploymentMap, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildTier1DeploymentMap", 
  "module_id": "PolicyEnforcementPointManagement", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildTier1DeploymentMap"
  }, 
  "properties": {
    "Tier1DeploymentMap": {
      "$ref": "Tier1DeploymentMap, 
      "description": "Contains the actual Tier1DeploymentMap object.", 
      "required": true, 
      "title": "Tier1DeploymentMap"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for Tier1DeploymentMap", 
  "type": "object"
}

ChildTier1Interface (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for Tier1Interface, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildTier1Interface", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildTier1Interface"
  }, 
  "properties": {
    "Tier1Interface": {
      "$ref": "Tier1Interface, 
      "description": "Contains the actual Tier1Interface object.", 
      "required": true, 
      "title": "Tier1Interface"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for Tier1Interface", 
  "type": "object"
}

ChildTlsCertificate (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for TlsCertificate, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildTlsCertificate", 
  "module_id": "PolicyCertificate", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildTlsCertificate"
  }, 
  "properties": {
    "TlsCertificate": {
      "$ref": "TlsCertificate, 
      "description": "Contains the actual TlsCertificate object.", 
      "required": true, 
      "title": "TlsCertificate"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for TlsCertificate", 
  "type": "object"
}

ChildTlsCrl (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for TlsCrl, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildTlsCrl", 
  "module_id": "PolicyCertificate", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildTlsCrl"
  }, 
  "properties": {
    "TlsCrl": {
      "$ref": "TlsCrl, 
      "description": "Contains the actual TlsCrl object.", 
      "required": true, 
      "title": "TlsCrl"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for TlsCrl", 
  "type": "object"
}

ChildTlsTrustData (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for TlsTrustData, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildTlsTrustData", 
  "module_id": "PolicyCertificate", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildTlsTrustData"
  }, 
  "properties": {
    "TlsTrustData": {
      "$ref": "TlsTrustData, 
      "description": "Contains the actual TlsTrustData object.", 
      "required": true, 
      "title": "TlsTrustData"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for TlsTrustData", 
  "type": "object"
}

ChildTraceflowConfig (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper for TraceflowConfig, used in hierarchical API", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildTraceflowConfig", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildTraceflowConfig"
  }, 
  "properties": {
    "TraceflowConfig": {
      "$ref": "TraceflowConfig, 
      "description": "Contains the actual TraceflowConfig object.", 
      "required": true, 
      "title": "TraceflowConfig"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for TraceflowConfig", 
  "type": "object"
}

ChildTypesRequestParameter (type)

{
  "description": "Specified child resource types will be populated in the response body", 
  "id": "ChildTypesRequestParameter", 
  "module_id": "Policy", 
  "properties": {
    "base_path": {
      "description": "Base path of the resource for which user wants to retrieve the hierarchy. This should be the fully qualified path for the resource. - Sample examples - base_path=/infra/domains/default/groups/Group1 base_path=/infra/domains/default/security-policies/SecurityPolicy1/rules/Rule1", 
      "required": false, 
      "title": "Base Path for retrieving hierarchical intent", 
      "type": "string"
    }, 
    "filter": {
      "description": "Filter string, can contain multiple or single java regular expressions separated by ';'. - Sample query string to prevent loading services and deployment zones: filter=Type-^(?!.*?(?:Service|DeploymentZone)).*$ - Sample query string to load every policy object under Infra: filter=/", 
      "required": false, 
      "title": "Filter string as java regex", 
      "type": "string"
    }, 
    "type_filter": {
      "description": "Advanced filter string in which user can directly specify the resourceTypes to be filtered. Can be used in conjunction with base_path. - Sample example of type_filter to load all groups - type_filter=Group - Sample example of multiple type_filter - type_filter=Group;SercurityPolicy;RedirectionPolicy - Sample eaxmple to load all groups in default domain using base_path in conjunction with type_filter - base_path=/infra/domains/default&type_filter=Group", 
      "required": false, 
      "title": "Filter string to retrieve hierarchy.", 
      "type": "string"
    }
  }, 
  "title": "Filter to populate child types of the policyConfigResource", 
  "type": "object"
}

ChildVirtualEndpoint (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for VirtualEndpoint used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildVirtualEndpoint", 
  "module_id": "PolicyServiceInsertion", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildVirtualEndpoint"
  }, 
  "properties": {
    "VirtualEndpoint": {
      "$ref": "VirtualEndpoint, 
      "description": "Contains reference to actual VirtualEndpoint.", 
      "required": true, 
      "title": "VirtualEndpoint"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for VirtualEndpoint", 
  "type": "object"
}

ChildVniPoolConfig (type)

{
  "additionalProperties": false, 
  "description": "Child wrapper object for VniPoolConfig, used in hierarchical API.", 
  "extends": {
    "$ref": "ChildPolicyConfigResource
  }, 
  "id": "ChildVniPoolConfig", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ChildVniPoolConfig"
  }, 
  "properties": {
    "VniPoolConfig": {
      "$ref": "VniPoolConfig, 
      "description": "Contains the actual VniPoolConfig object.", 
      "required": true, 
      "title": "VniPoolConfig"
    }, 
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mark_for_override": {
      "default": false, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "If this field is set to true, delete operation is triggered on the intent tree. This resource along with its all children in intent tree will be deleted. This is a cascade delete and should only be used if intent object along with its all children are to be deleted. This does not support deletion of single non-leaf node within the tree and should be used carefully.", 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Wrapper object for VniPoolConfig", 
  "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": "TLS cipher suite", 
  "type": "object"
}

ClasslessStaticRoute (type)

{
  "additionalProperties": false, 
  "description": "DHCP classless static route option.", 
  "id": "ClasslessStaticRoute", 
  "module_id": "Dhcp", 
  "properties": {
    "network": {
      "$ref": "IPElement, 
      "description": "Destination network in CIDR format.", 
      "required": true, 
      "title": "Destination in CIDR"
    }, 
    "next_hop": {
      "$ref": "IPAddress, 
      "description": "IP address of next hop of the route.", 
      "required": true, 
      "title": "Router"
    }
  }, 
  "title": "DHCP classless static route option", 
  "type": "object"
}

ClientAuthType (type)

{
  "additionalProperties": false, 
  "description": "Client authentication could be REQUIRED or IGNORE. REQUIRED means that client is required to present its certificate to the server for authentication. To be accepted, client certificate must be signed by one of the trusted Certificate Authorities (CAs), also referred to as root CAs, whose self signed certificates are specified in the same client SSL profile binding. IGNORE means that client certificate would be ignored.", 
  "enum": [
    "REQUIRED", 
    "IGNORE"
  ], 
  "id": "ClientAuthType", 
  "module_id": "LoadBalancer", 
  "title": "client authentication mode", 
  "type": "string"
}

CloudNativeServiceInstance (type)

{
  "additionalProperties": false, 
  "description": "Stores the information about cloud native service instance.", 
  "extends": {
    "$ref": "DiscoveredResource
  }, 
  "id": "CloudNativeServiceInstance", 
  "module_id": "InventoryCloudObj", 
  "properties": {
    "_last_sync_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "external_id": {
      "description": "Id of service instance fetched from public cloud.", 
      "readonly": true, 
      "required": true, 
      "title": "External id of cloud native service instance in the system.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }, 
    "service_type": {
      "description": "Type of cloud native service.", 
      "readonly": true, 
      "required": true, 
      "title": "Type of cloud native service; possible values are ELB, RDS", 
      "type": "string"
    }, 
    "source": {
      "$ref": "ResourceReference, 
      "description": "Reference of the public cloud gateway that reported the service instance.", 
      "readonly": true, 
      "required": true, 
      "title": "Reference of the public cloud gateway"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

ClusterBackupInfo (type)

{
  "additionalProperties": false, 
  "id": "ClusterBackupInfo", 
  "module_id": "ClusterRestore", 
  "properties": {
    "ip_address": {
      "format": "hostname-or-ip", 
      "readonly": true, 
      "required": true, 
      "title": "IP address or FQDN of the node from which the backup was taken", 
      "type": "string"
    }, 
    "node_id": {
      "readonly": true, 
      "required": true, 
      "title": "ID of the node from which the backup was taken", 
      "type": "string"
    }, 
    "restore_type": {
      "default": [], 
      "items": {
        "enum": [
          "REGULAR_RESTORE", 
          "POLICY_ONLY_RESTORE"
        ], 
        "type": "string"
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Type of restore allowed", 
      "type": "array", 
      "uniqueItems": true
    }, 
    "timestamp": {
      "$ref": "EpochMsTimestamp, 
      "readonly": true, 
      "required": true, 
      "title": "timestamp of the cluster backup file"
    }
  }, 
  "title": "Cluster backup details", 
  "type": "object"
}

ClusterBackupInfoListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ClusterBackupInfoListResult", 
  "module_id": "ClusterRestore", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "ClusterBackupInfo
      }, 
      "readonly": true, 
      "required": true, 
      "title": "List of timestamps of backed-up cluster files", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ClusterCertificateId (type)

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

ClusterConfiguration (type)

{
  "additionalProperties": false, 
  "description": "The configuration of the NSX cluster. The cluster configuration consists of a list of cluster node attributes.", 
  "id": "ClusterConfiguration", 
  "module_id": "Cluster", 
  "properties": {
    "cluster_id": {
      "readonly": true, 
      "title": "UUID of the cluster", 
      "type": "string"
    }, 
    "config_version": {
      "readonly": true, 
      "title": "Cluster configuration version", 
      "type": "integer"
    }, 
    "nodes": {
      "items": {
        "$ref": "ClusterNode
      }, 
      "readonly": true, 
      "title": "Nodes in the cluster configuration", 
      "type": "array"
    }
  }, 
  "title": "Cluster configuration", 
  "type": "object"
}

ClusterNode (type)

{
  "additionalProperties": false, 
  "description": "This type contains attributes of a cluster node that are relevant to the Cluster Boot Manager.", 
  "id": "ClusterNode", 
  "module_id": "Cluster", 
  "properties": {
    "entities": {
      "items": {
        "$ref": "ClusterNodeEntity
      }, 
      "required": true, 
      "title": "Entities on the node", 
      "type": "array"
    }, 
    "node_uuid": {
      "required": true, 
      "title": "UUID of the node", 
      "type": "string"
    }, 
    "status": {
      "default": "REMOVED", 
      "enum": [
        "JOINING", 
        "JOINED", 
        "REMOVING", 
        "REMOVED"
      ], 
      "title": "Current clustering status of the node", 
      "type": "string"
    }
  }, 
  "title": "Cluster Node Properties", 
  "type": "object"
}

ClusterNodeEntity (type)

{
  "additionalProperties": false, 
  "description": "NSX Cluster is made up of multiple cluster nodes. Each node can perform multiple functions, commonly referred to as roles. Cluster node entities are processes running in a cluster node that assist in the performance of a role. Cluster Boot Manager is a daemon that securely bootstraps and configures the entities. This type contains attributes of a cluster node entity that are relevant to the Cluster Boot Manager.", 
  "id": "ClusterNodeEntity", 
  "module_id": "Cluster", 
  "properties": {
    "certificate": {
      "required": true, 
      "title": "Public certificate of the entity in PEM format", 
      "type": "string"
    }, 
    "entity_type": {
      "enum": [
        "MANAGER", 
        "CONTROLLER", 
        "POLICY", 
        "HTTPS", 
        "CLUSTER_BOOT_MANAGER", 
        "DATASTORE", 
        "GLOBAL_MANAGER", 
        "ASYNC_REPLICATOR", 
        "MONITORING", 
        "IDPS_REPORTING", 
        "CORFU_NONCONFIG"
      ], 
      "required": true, 
      "title": "Type of the entity", 
      "type": "string"
    }, 
    "entity_uuid": {
      "required": true, 
      "title": "UUID of the entity", 
      "type": "string"
    }, 
    "fqdn": {
      "format": "hostname", 
      "required": false, 
      "title": "Domain name the entity binds to", 
      "type": "string"
    }, 
    "ip_address": {
      "required": false, 
      "title": "IP address the entity binds to", 
      "type": "string"
    }, 
    "port": {
      "maximum": 65535, 
      "minimum": 0, 
      "required": false, 
      "title": "Port the entity binds to", 
      "type": "integer"
    }, 
    "subnet_prefix_length": {
      "maximum": 32, 
      "minimum": 0, 
      "required": false, 
      "title": "Subnet mask prefix length of the entity binds to", 
      "type": "integer"
    }
  }, 
  "title": "Cluster Node Entity Properties", 
  "type": "object"
}

ClusterRestoreStatus (type)

{
  "id": "ClusterRestoreStatus", 
  "module_id": "ClusterRestore", 
  "properties": {
    "backup_timestamp": {
      "$ref": "EpochMsTimestamp, 
      "readonly": true, 
      "required": true, 
      "title": "Timestamp when backup was initiated in epoch millisecond"
    }, 
    "endpoints": {
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "required": true, 
      "title": "The list of allowed endpoints, based on the current state of\nthe restore process\n", 
      "type": "array"
    }, 
    "id": {
      "readonly": true, 
      "required": true, 
      "title": "Unique id for backup request", 
      "type": "string"
    }, 
    "instructions": {
      "items": {
        "$ref": "InstructionInfo
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Instructions for users to reconcile Restore operations", 
      "type": "array"
    }, 
    "restore_end_time": {
      "$ref": "EpochMsTimestamp, 
      "readonly": true, 
      "required": false, 
      "title": "Timestamp when restore was completed in epoch millisecond"
    }, 
    "restore_start_time": {
      "$ref": "EpochMsTimestamp, 
      "readonly": true, 
      "required": false, 
      "title": "Timestamp when restore was started in epoch millisecond"
    }, 
    "status": {
      "$ref": "GlobalRestoreStatus
    }, 
    "step": {
      "$ref": "RestoreStep
    }, 
    "total_steps": {
      "readonly": true, 
      "required": true, 
      "title": "Total number of steps in the entire restore process", 
      "type": "integer"
    }
  }, 
  "title": "Cluster restore status", 
  "type": "object"
}

ClusterRestoreStatusRequestParameters (type)

{
  "id": "ClusterRestoreStatusRequestParameters", 
  "properties": {
    "restore_component": {
      "default": "LOCAL_MANAGER", 
      "enum": [
        "LOCAL_MANAGER", 
        "GLOBAL_MANAGER"
      ], 
      "readonly": true, 
      "required": false, 
      "type": "string"
    }
  }, 
  "type": "object"
}

ClusterVirtualIpProperties (type)

{
  "additionalProperties": false, 
  "id": "ClusterVirtualIpProperties", 
  "properties": {
    "ip_address": {
      "required": true, 
      "title": "Virtual IP address, 0.0.0.0 if not configured", 
      "type": "string"
    }
  }, 
  "title": "Cluster virtual IP properties", 
  "type": "object"
}

ColumnItem (type)

{
  "additionalProperties": false, 
  "description": "Represents a column of the Grid", 
  "id": "ColumnItem", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "properties": {
    "column_identifier": {
      "description": "Identifies the column and used for fetching content upon an user click or drilldown. If column identifier is not provided, the column's data will not participate in searches and drilldowns.", 
      "title": "Identifier for this column", 
      "type": "string"
    }, 
    "drilldown_id": {
      "description": "Id of drilldown widget, if any. Id should be a valid id of an existing widget.", 
      "maxLength": 255, 
      "title": "Id of drilldown widget", 
      "type": "string"
    }, 
    "field": {
      "description": "Field from which values of the column will be derived.", 
      "maxLength": 1024, 
      "required": true, 
      "title": "Column Field", 
      "type": "string"
    }, 
    "hidden": {
      "default": false, 
      "description": "If set to true, hides the column", 
      "title": "Hide the column", 
      "type": "boolean"
    }, 
    "label": {
      "$ref": "Label, 
      "description": "Label of the column.", 
      "readonly": false, 
      "required": true, 
      "title": "Column Label"
    }, 
    "navigation": {
      "description": "Hyperlink of the specified UI page that provides details. If drilldown_id is provided, then navigation cannot be used.", 
      "maxLength": 1024, 
      "title": "Navigation to a specified UI page", 
      "type": "string"
    }, 
    "render_configuration": {
      "description": "Render configuration to be applied, if any.", 
      "items": {
        "$ref": "RenderConfiguration
      }, 
      "title": "Render Configuration", 
      "type": "array"
    }, 
    "sort_ascending": {
      "default": true, 
      "description": "If true, the value of the column are sorted in ascending order. Otherwise, in descending order.", 
      "title": "Represents order of sorting the values", 
      "type": "boolean"
    }, 
    "sort_key": {
      "description": "Sorting on column is based on the sort_key. sort_key represents the field in the output data on which sort is requested.", 
      "maxLength": 255, 
      "title": "Key for sorting on this column", 
      "type": "string"
    }, 
    "tooltip": {
      "description": "Multi-line text to be shown on tooltip while hovering over a cell in the grid.", 
      "items": {
        "$ref": "Tooltip
      }, 
      "title": "Multi-line tooltip", 
      "type": "array"
    }, 
    "type": {
      "default": "String", 
      "description": "Data type of the field.", 
      "enum": [
        "String", 
        "Number", 
        "Date"
      ], 
      "maxLength": 255, 
      "required": true, 
      "title": "Field data type", 
      "type": "string"
    }
  }, 
  "title": "Grid Column", 
  "type": "object"
}

CommunicationEntry (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "A communication entry indicates the action to be performed for various types of traffic flowing between workload groups. This type is deprecated. Use the type Rule instead.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "CommunicationEntry", 
  "module_id": "Policy", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "action": {
      "description": "The action to be applied to all the services.", 
      "enum": [
        "ALLOW", 
        "DROP", 
        "REJECT"
      ], 
      "required": false, 
      "title": "Action", 
      "type": "string"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "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 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.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 128, 
      "required": false, 
      "title": "Destination group paths", 
      "type": "array"
    }, 
    "direction": {
      "default": "IN_OUT", 
      "description": "Define direction of traffic.", 
      "enum": [
        "IN", 
        "OUT", 
        "IN_OUT"
      ], 
      "required": false, 
      "title": "Direction", 
      "type": "string"
    }, 
    "disabled": {
      "default": false, 
      "description": "Flag to disable the rule. Default is enabled.", 
      "readonly": false, 
      "required": false, 
      "title": "Flag to disable the rule", 
      "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, 
      "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"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "notes": {
      "description": "Text for additional notes on changes.", 
      "required": false, 
      "title": "Text for additional notes on changes", 
      "type": "string"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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"
    }, 
    "scope": {
      "description": "The list of policy paths where the communication entry is applied Edge/LR/T0/T1/LRP/CGW/MGW/etc. Note that a given rule can be applied on multiple LRs/LRPs.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 128, 
      "required": false, 
      "type": "array"
    }, 
    "sequence_number": {
      "description": "This field is used to resolve conflicts between multiple CommunicationEntries under CommunicationMap for a Domain If no sequence number is specified in the payload, a value of 0 is assigned by default. If there are multiple communication entries with the same sequence number then their order is not deterministic. If a specific order of communication entry is desired, then one has to specify unique sequence numbers or use the POST request on the communication entry entity with a query parameter action=revise to let the framework assign a sequence number", 
      "required": false, 
      "title": "Sequence number of the this CommunicationEntry", 
      "type": "int"
    }, 
    "services": {
      "description": "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.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 128, 
      "required": false, 
      "title": "Names of services", 
      "type": "array"
    }, 
    "source_groups": {
      "description": "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.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 128, 
      "required": false, 
      "title": "Source group paths", 
      "type": "array"
    }, 
    "tag": {
      "description": "User level field which will be printed in CLI and packet logs.", 
      "maxLength": 32, 
      "required": false, 
      "title": "Tag applied on the communication entry", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "A communication entry specifies the security policy between the workload groups", 
  "type": "object"
}

CommunicationMap (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "Ordered list of CommunicationEntries. This object is created by default along with the Domain. This type is deprecated. Use the type SecurityPolicy instead.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "CommunicationMap", 
  "module_id": "Policy", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "category": {
      "description": "- Distributed Firewall - Policy framework for Distributed Firewall provides four pre-defined categories for classifying a communication map. They are \"Emergency\", \"Infrastructure\", \"Environment\" and \"Application\". Amongst the layer 3 communication maps,there is a pre-determined order in which the policy framework manages the priority of these communication maps. Emergency category has the highest priority followed by Infrastructure, Environment and then Application rules. Administrator can choose to categorize a communication  map into the above categories or can choose to leave it empty. If empty it will have the least precedence w.r.t the above four layer 3 categories.", 
      "required": false, 
      "title": "A way to classify a communication map, if needed.", 
      "type": "string"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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 across domains. In order to change the precedence of a communication map one can fire a POST request on the communication map entity with a query parameter 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. If no precedence is specified in the payload, a value of 0 is assigned by default. If there are multiple communication maps with the same precedence then their order is not deterministic. If a specific order of communication map is desired, then one has to specify a unique precedence or use the POST request on the communication map entity with a query parameter action=revise to let the framework assign a precedence", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Contains ordered list of CommunicationEntries", 
  "type": "object"
}

CommunityList (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "CommunityList", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "communities": {
      "description": "List of BGP community entries. Both standard and large communities are supported. Standard community format: aa:nn where aa and nn must be within the range [1 - 65536]. Large BGP Community format: aa:bb:nn where aa (Global Administrator), bb  (Local Data Part 1) and nn (Local Data Part 2) must be within the range [1 - 4294967295]. In additon to numbered communites (e.g. 3356:2040), predefined communities (NO_EXPORT, NO_ADVERTISE, NO_EXPORT_SUBCONFED) are supported.", 
      "items": {
        "type": "string"
      }, 
      "minItems": 1, 
      "required": true, 
      "title": "List of BGP community entries", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Community list for BGP routing configuration", 
  "type": "object"
}

CommunityListListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "CommunityListListResult", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "CommunityList
      }, 
      "required": true, 
      "title": "CommunityList results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged collection of CommunityLists", 
  "type": "object"
}

CommunityMatchCriteria (type)

{
  "additionalProperties": false, 
  "id": "CommunityMatchCriteria", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "criteria": {
      "description": "Match criteria specified as a community list path or a regular expression.", 
      "required": true, 
      "title": "Match criteria based on community list path or a regular expression", 
      "type": "string"
    }, 
    "match_operator": {
      "description": "Match operator for community list entries. Not valid when a regular expression is specified for criteria.", 
      "enum": [
        "MATCH_ANY", 
        "MATCH_ALL", 
        "MATCH_EXACT", 
        "MATCH_COMMUNITY_REGEX", 
        "MATCH_LARGE_COMMUNITY_REGEX"
      ], 
      "required": false, 
      "title": "Match operator for community list entries", 
      "type": "string"
    }
  }, 
  "title": "Match criteria based on a community list", 
  "type": "object"
}

CompatibilityDetail (type)

{
  "description": "Feature compatibility status details indicating specific site configuration incompatibility with global manager configuration.", 
  "id": "CompatibilityDetail", 
  "module_id": "GmConfigOnboarding", 
  "properties": {
    "attributes": {
      "items": {
        "$ref": "OnboardingAttribute
      }, 
      "maxItems": 20, 
      "readonly": true, 
      "required": false, 
      "title": "Additional Attributes", 
      "type": "array"
    }, 
    "status_code": {
      "description": "Unique integer number indicating configuration incompatibility.", 
      "readonly": true, 
      "required": true, 
      "title": "Status Code", 
      "type": "integer"
    }, 
    "status_message": {
      "description": "A brief explaination of status code.", 
      "readonly": true, 
      "required": false, 
      "title": "Status Message", 
      "type": "string"
    }
  }, 
  "title": "Feature Compatibility Details", 
  "type": "object"
}

ComponentTargetVersion (type)

{
  "id": "ComponentTargetVersion", 
  "module_id": "Upgrade", 
  "properties": {
    "component_type": {
      "readonly": true, 
      "required": true, 
      "type": "string"
    }, 
    "target_version": {
      "readonly": true, 
      "required": true, 
      "type": "string"
    }
  }, 
  "type": "object"
}

ComponentTypeListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "ComponentTypeListRequestParameters", 
  "module_id": "Upgrade", 
  "properties": {
    "component_type": {
      "readonly": false, 
      "required": false, 
      "title": "Component type on which the action is performed or on which the results are filtered", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ComponentUpgradeChecksInfo (type)

{
  "additionalProperties": false, 
  "description": "Meta-data of pre/post-upgrade checks for a component", 
  "id": "ComponentUpgradeChecksInfo", 
  "module_id": "Upgrade", 
  "properties": {
    "component_type": {
      "description": "Component type of the pre/post-upgrade checks", 
      "readonly": false, 
      "required": true, 
      "title": "Component type", 
      "type": "string"
    }, 
    "post_upgrade_checks_info": {
      "items": {
        "$ref": "UpgradeCheckInfo
      }, 
      "required": false, 
      "title": "Collection of post-upgrade checks", 
      "type": "array"
    }, 
    "pre_upgrade_checks_info": {
      "items": {
        "$ref": "UpgradeCheckInfo
      }, 
      "required": false, 
      "title": "Collection of pre-upgrade checks", 
      "type": "array"
    }
  }, 
  "title": "Meta-data of pre/post-upgrade checks for a component", 
  "type": "object"
}

ComponentUpgradeChecksInfoListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ComponentUpgradeChecksInfoListResult", 
  "module_id": "Upgrade", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "ComponentUpgradeChecksInfo
      }, 
      "required": true, 
      "title": "Collection of info of pre/post-upgrade checks for components", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ComponentUpgradeStatus (type)

{
  "additionalProperties": false, 
  "id": "ComponentUpgradeStatus", 
  "module_id": "Upgrade", 
  "properties": {
    "can_skip": {
      "readonly": true, 
      "required": false, 
      "title": "Can the upgrade of the remaining units in this component be skipped", 
      "type": "boolean"
    }, 
    "component_type": {
      "readonly": true, 
      "required": false, 
      "title": "Component type for the upgrade status", 
      "type": "string"
    }, 
    "current_version_node_summary": {
      "$ref": "NodeSummaryList, 
      "readonly": true, 
      "required": false, 
      "title": "Mapping of current versions of nodes and counts of nodes at the respective versions."
    }, 
    "details": {
      "readonly": true, 
      "required": false, 
      "title": "Details about the upgrade status", 
      "type": "string"
    }, 
    "node_count_at_target_version": {
      "description": "Number of nodes of the type and at the component version", 
      "readonly": true, 
      "required": false, 
      "title": "Count of nodes at target component version", 
      "type": "int"
    }, 
    "percent_complete": {
      "readonly": true, 
      "required": true, 
      "title": "Indicator of upgrade progress in percentage", 
      "type": "number"
    }, 
    "pre_upgrade_status": {
      "$ref": "UpgradeChecksExecutionStatus, 
      "readonly": true, 
      "required": false, 
      "title": "Pre-upgrade status of the component-type"
    }, 
    "status": {
      "enum": [
        "SUCCESS", 
        "FAILED", 
        "IN_PROGRESS", 
        "NOT_STARTED", 
        "PAUSING", 
        "PAUSED"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Upgrade status of component", 
      "type": "string"
    }, 
    "target_component_version": {
      "readonly": true, 
      "required": false, 
      "title": "Target component version", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ComputeClusterIdfwConfiguration (type)

{
  "additionalProperties": false, 
  "description": "Idfw configuration for enable/disable idfw on cluster level.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "ComputeClusterIdfwConfiguration", 
  "module_id": "PolicyFirewallConfiguration", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "cluster_idfw_enabled": {
      "description": "If set to true, idfw is enabled for this cluster", 
      "readonly": false, 
      "required": true, 
      "title": "Idfw enabled flag", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "member": {
      "$ref": "PolicyResourceReference, 
      "description": "Contains actual policy resource reference object", 
      "required": true, 
      "title": "PolicyResourceReference"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Compute cluster idfw configuration", 
  "type": "object"
}

ComputeCollection (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "DiscoveredResource
  }, 
  "id": "ComputeCollection", 
  "module_id": "InventoryCmObj", 
  "properties": {
    "_last_sync_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cm_local_id": {
      "readonly": true, 
      "required": true, 
      "title": "Local Id of the compute collection in the Compute Manager", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "external_id": {
      "readonly": true, 
      "required": true, 
      "title": "External ID of the ComputeCollection in the source Compute manager,\ne.g. mo-ref in VC\n", 
      "type": "string"
    }, 
    "origin_id": {
      "readonly": true, 
      "required": true, 
      "title": "Id of the compute manager from where this Compute Collection was discovered", 
      "type": "string"
    }, 
    "origin_properties": {
      "items": {
        "$ref": "KeyValuePair
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Key-Value map of additional specific properties of\ncompute collection in the Compute Manager\n", 
      "type": "array"
    }, 
    "origin_type": {
      "readonly": true, 
      "required": true, 
      "title": "ComputeCollection type like VC_Cluster. Here the Compute Manager\ntype prefix would help in differentiating similar named Compute\nCollection types from different Compute Managers\n", 
      "type": "string"
    }, 
    "owner_id": {
      "readonly": true, 
      "required": false, 
      "title": "Id of the owner of compute collection in the Compute Manager", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

Condition (type)

{
  "additionalProperties": false, 
  "description": "Represents the leaf level condition. Evaluation of the condition expression will be case insensitive.", 
  "extends": {
    "$ref": "Expression
  }, 
  "id": "Condition", 
  "module_id": "Policy", 
  "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: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "key": {
      "enum": [
        "Tag", 
        "Name", 
        "OSName", 
        "ComputerName"
      ], 
      "required": true, 
      "title": "Key", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "member_type": {
      "enum": [
        "IPSet", 
        "VirtualMachine", 
        "LogicalPort", 
        "LogicalSwitch", 
        "Segment", 
        "SegmentPort"
      ], 
      "required": true, 
      "title": "Group member type", 
      "type": "string"
    }, 
    "operator": {
      "enum": [
        "EQUALS", 
        "CONTAINS", 
        "STARTSWITH", 
        "ENDSWITH", 
        "NOTEQUALS"
      ], 
      "required": true, 
      "title": "operator", 
      "type": "string"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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", 
        "ExternalIDExpression", 
        "PathExpression", 
        "IdentityGroupExpression"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }, 
    "value": {
      "minLength": 1, 
      "required": true, 
      "title": "Value", 
      "type": "string"
    }
  }, 
  "title": "Represents the leaf level condition", 
  "type": "object"
}

ConditionalValueConstraintExpression (type)

{
  "additionalProperties": false, 
  "description": "Represents the leaf level expression to restrict the target attribute value based on the set of existing values. Generally, used in combination with RelatedAttributeConditionalExpression to constraint the values related to another attribute on the same resource. This object is always used in conjunction with some exression. Example - {   \"condition\" : {       \"operator\":\"INCLUDES\",       \"rhs_value\": [\"/infra/domains/mgw/groups/VCENTER\", \"/infra/domains/mgw/groups/SRM\", \"/infra/domains/mgw/groups/NSX\"],       \"value_constraint\": {           \"resource_type\": \"ValueConstraintExpression\",           \"operator\":\"EXCLUDES\",           \"values\":[\"/infra/domains/mgw/groups/VCENTER\", \"/infra/domains/mgw/groups/SRM\", \"/infra/domains/mgw/groups/NSX\"]   } }", 
  "id": "ConditionalValueConstraintExpression", 
  "module_id": "PolicyConstraints", 
  "properties": {
    "operator": {
      "enum": [
        "INCLUDES", 
        "EXCLUDES", 
        "EQUALS"
      ], 
      "required": true, 
      "title": "Set operation to constraint values.", 
      "type": "string"
    }, 
    "rhs_value": {
      "description": "List of values.", 
      "items": {
        "type": "string"
      }, 
      "required": true, 
      "title": "Array of values to perform operation.", 
      "type": "array"
    }, 
    "value_constraint": {
      "$ref": "ValueConstraintExpression, 
      "description": "Values to apply the conditional constraint on target.", 
      "required": true, 
      "title": "Value Constraint"
    }
  }, 
  "title": "Represents the leaf level conditional value constraint.", 
  "type": "object"
}

ConfigOnboardingConflictRequest (type)

{
  "additionalProperties": false, 
  "description": "Config onboarding request to verify conflicts in onboarding configuration on global manager for a site.", 
  "id": "ConfigOnboardingConflictRequest", 
  "module_id": "GmConfigOnboarding", 
  "properties": {
    "prefix": {
      "description": "User provided prefix string to resolve conflicting site entities.", 
      "readonly": true, 
      "required": false, 
      "title": "Prefix string", 
      "type": "string"
    }, 
    "site_id": {
      "description": "Site Id.", 
      "readonly": true, 
      "required": false, 
      "title": "Site Id", 
      "type": "string"
    }, 
    "suffix": {
      "description": "User provided suffix string to resolve conflicting site entities.", 
      "title": "Suffix string", 
      "type": "string"
    }
  }, 
  "title": "Config onboarding conflict Request", 
  "type": "object"
}

ConfigOnboardingConflictStatus (type)

{
  "additionalProperties": false, 
  "description": "Represents config onboarding conflict status on Global Manager.", 
  "id": "ConfigOnboardingConflictStatus", 
  "module_id": "GmConfigOnboarding", 
  "properties": {
    "details": {
      "$ref": "OnboardingFeatureInfo, 
      "readonly": true, 
      "required": false
    }, 
    "site_id": {
      "description": "Site identifier of the site being onboarded.", 
      "readonly": true, 
      "required": true, 
      "title": "Site Id", 
      "type": "string"
    }, 
    "status": {
      "$ref": "OnboardingConflictStatus, 
      "readonly": true, 
      "required": true
    }
  }, 
  "title": "Config onboarding conflict status", 
  "type": "object"
}

ConfigOnboardingError (type)

{
  "description": "Represents error details in case of system fail to onboard site configuration on global manager.", 
  "id": "ConfigOnboardingError", 
  "module_id": "GmConfigOnboarding", 
  "properties": {
    "error_code": {
      "description": "Error code for errors found during onboarding process.", 
      "readonly": true, 
      "required": false, 
      "title": "Error Code", 
      "type": "integer"
    }, 
    "error_message": {
      "description": "Failure reason during onboarding process.", 
      "readonly": true, 
      "required": false, 
      "title": "Error message", 
      "type": "string"
    }
  }, 
  "title": "Config Onboarding Error", 
  "type": "object"
}

ConfigOnboardingInProgressStatus (type)

{
  "description": "Represents config onboarding status including processing phase compared to of total number of phases to complete config onboarding.", 
  "id": "ConfigOnboardingInProgressStatus", 
  "module_id": "GmConfigOnboarding", 
  "properties": {
    "current_step": {
      "description": "Represent intermidiate phase when onboarding or rollback is in-progress on global manager.", 
      "readonly": true, 
      "required": false, 
      "title": "Current Onboarding Step", 
      "type": "integer"
    }, 
    "feature": {
      "$ref": "OnboardingFeatureInfo, 
      "readonly": true, 
      "required": false
    }, 
    "stage": {
      "$ref": "OnboardingStage, 
      "readonly": true, 
      "required": false
    }, 
    "total_steps": {
      "description": "Total number of phases involved in onboarding workflow.", 
      "readonly": true, 
      "required": false, 
      "title": "Total number of Onboarding Steps", 
      "type": "integer"
    }
  }, 
  "title": "Config Onboarding in-progress status", 
  "type": "object"
}

ConfigOnboardingRequest (type)

{
  "additionalProperties": false, 
  "description": "Config onboarding request to initiate onboarding workflow on global manager for a site.", 
  "id": "ConfigOnboardingRequest", 
  "module_id": "GmConfigOnboarding", 
  "properties": {
    "prefix": {
      "description": "User provided prefix string to resolve conflicting site entities.", 
      "readonly": true, 
      "required": false, 
      "title": "Prefix string", 
      "type": "string"
    }, 
    "site_backup_reference": {
      "description": "Site backup image details to hint user to restore site before starting onboarding process.", 
      "readonly": true, 
      "required": true, 
      "title": "Site Backup Reference", 
      "type": "string"
    }, 
    "site_id": {
      "description": "Site Id.", 
      "readonly": true, 
      "required": false, 
      "title": "Site Id", 
      "type": "string"
    }, 
    "suffix": {
      "description": "User provided suffix string to resolve conflicting site entities.", 
      "title": "Suffix string", 
      "type": "string"
    }
  }, 
  "title": "Config onboarding Request", 
  "type": "object"
}

ConfigOnboardingStatus (type)

{
  "additionalProperties": false, 
  "description": "Represents config onboarding status on Global Manager.", 
  "id": "ConfigOnboardingStatus", 
  "module_id": "GmConfigOnboarding", 
  "properties": {
    "details": {
      "$ref": "ConfigOnboardingStatusDetails, 
      "readonly": true, 
      "required": false
    }, 
    "site_id": {
      "description": "Site identifier of the site being onboarded.", 
      "readonly": true, 
      "required": true, 
      "title": "Site Id", 
      "type": "string"
    }, 
    "status": {
      "$ref": "OnboardingStatus, 
      "readonly": true, 
      "required": true
    }, 
    "supported_features": {
      "description": "List of supported features on global manager.", 
      "items": {
        "$ref": "OnboardingFeatureInfo
      }, 
      "readonly": true, 
      "required": false, 
      "title": "List of supported features", 
      "type": "array"
    }, 
    "timestamp": {
      "$ref": "EpochMsTimestamp, 
      "description": "Onboarding status as of current timestamp.", 
      "readonly": false, 
      "required": true, 
      "title": "Status Timestamp"
    }, 
    "unsupported_features": {
      "description": "List of unsupported features on global manager.", 
      "items": {
        "$ref": "OnboardingFeatureInfo
      }, 
      "readonly": true, 
      "required": false, 
      "title": "List of unsupported features", 
      "type": "array"
    }
  }, 
  "title": "Config on-boarding status", 
  "type": "object"
}

ConfigOnboardingStatusDetails (type)

{
  "description": "Represents config on-boarding progress phase details per feature information with progress metric like completed entity count against total number of entities.", 
  "id": "ConfigOnboardingStatusDetails", 
  "module_id": "GmConfigOnboarding", 
  "properties": {
    "error_messages": {
      "items": {
        "$ref": "ConfigOnboardingError
      }, 
      "readonly": true, 
      "required": false, 
      "type": "array"
    }, 
    "import_progress": {
      "$ref": "ConfigOnboardingInProgressStatus, 
      "readonly": true, 
      "required": false
    }, 
    "revert_progress": {
      "$ref": "ConfigOnboardingInProgressStatus, 
      "readonly": true, 
      "required": false
    }, 
    "site_backup_reference": {
      "description": "Site backup image details to hint user to restore site before starting onboarding process.", 
      "readonly": true, 
      "required": false, 
      "title": "Site Backup Reference", 
      "type": "string"
    }
  }, 
  "title": "Config on-boarding status details", 
  "type": "object"
}

ConfigState (type)

{
  "additionalProperties": false, 
  "description": "Configuration State.", 
  "enum": [
    "SUCCESS", 
    "IN_PROGRESS", 
    "ERROR", 
    "UNKNOWN", 
    "UNINITIALIZED"
  ], 
  "id": "ConfigState", 
  "module_id": "PolicyRealizedState", 
  "title": "Config State", 
  "type": "string"
}

ConfigurationState (type)

{
  "id": "ConfigurationState", 
  "module_id": "Common", 
  "properties": {
    "details": {
      "items": {
        "$ref": "ConfigurationStateElement
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Array of configuration state of various sub systems", 
      "type": "array"
    }, 
    "failure_code": {
      "readonly": true, 
      "required": false, 
      "title": "Error code", 
      "type": "integer"
    }, 
    "failure_message": {
      "readonly": true, 
      "required": false, 
      "title": "Error message in case of failure", 
      "type": "string"
    }, 
    "state": {
      "description": "Gives details of state of desired configuration. Additional enums with more details on progress/success/error states are sent for edge node. The success states are NODE_READY and TRANSPORT_NODE_READY, pending states are {VM_DEPLOYMENT_QUEUED, VM_DEPLOYMENT_IN_PROGRESS, REGISTRATION_PENDING} and other values indicate failures. \"in_sync\" state indicates that the desired configuration has been received by the host to which it applies, but is not yet in effect. When the configuration is actually in effect, the state will change to \"success\". Please note, failed state is deprecated.", 
      "enum": [
        "pending", 
        "in_progress", 
        "success", 
        "failed", 
        "partial_success", 
        "orphaned", 
        "unknown", 
        "error", 
        "in_sync", 
        "NOT_AVAILABLE", 
        "VM_DEPLOYMENT_QUEUED", 
        "VM_DEPLOYMENT_IN_PROGRESS", 
        "VM_DEPLOYMENT_FAILED", 
        "VM_POWER_ON_IN_PROGRESS", 
        "VM_POWER_ON_FAILED", 
        "REGISTRATION_PENDING", 
        "NODE_NOT_READY", 
        "NODE_READY", 
        "VM_POWER_OFF_IN_PROGRESS", 
        "VM_POWER_OFF_FAILED", 
        "VM_UNDEPLOY_IN_PROGRESS", 
        "VM_UNDEPLOY_FAILED", 
        "VM_UNDEPLOY_SUCCESSFUL", 
        "EDGE_CONFIG_ERROR", 
        "VM_DEPLOYMENT_RESTARTED", 
        "REGISTRATION_FAILED", 
        "TRANSPORT_NODE_SYNC_PENDING", 
        "TRANSPORT_NODE_CONFIGURATION_MISSING", 
        "EDGE_HARDWARE_NOT_SUPPORTED", 
        "MULTIPLE_OVERLAY_TZS_NOT_SUPPORTED", 
        "TN_OVERLAY_TZ_IN_USE_BY_EDGE_CLUSTER", 
        "TZ_ENDPOINTS_NOT_SPECIFIED", 
        "NO_PNIC_PREPARED_IN_EDGE", 
        "APPLIANCE_INTERNAL_ERROR", 
        "VTEP_DHCP_NOT_SUPPORTED", 
        "UNSUPPORTED_HOST_SWITCH_PROFILE", 
        "UPLINK_HOST_SWITCH_PROFILE_NOT_SPECIFIED", 
        "HOSTSWITCH_PROFILE_NOT_FOUND", 
        "LLDP_SEND_ENABLED_NOT_SUPPORTED", 
        "UNSUPPORTED_NAMED_TEAMING_POLICY", 
        "LBSRCID_NOT_SUPPORTED_FOR_EDGE_VM", 
        "LACP_NOT_SUPPORTED_FOR_EDGE_VM", 
        "STANDBY_UPLINKS_NOT_SUPPORTED_FOR_EDGE_VM", 
        "MULTIPLE_ACTIVE_UPLINKS_NOT_SUPPORTED_FOR_EDGE", 
        "UNSUPPORTED_LACP_LB_ALGO_FOR_NODE", 
        "EDGE_NODE_VERSION_NOT_SUPPORTED", 
        "NO_PNIC_SPECIFIED_IN_TN", 
        "INVALID_PNIC_DEVICE_NAME", 
        "TRANSPORT_NODE_READY", 
        "VM_NETWORK_EDIT_PENDING", 
        "UNSUPPORTED_DEFAULT_TEAMING_POLICY", 
        "MPA_DISCONNECTED", 
        "VM_RENAME_PENDING", 
        "VM_CONFIG_EDIT_PENDING", 
        "VM_NETWORK_EDIT_FAILED", 
        "VM_RENAME_FAILED", 
        "VM_CONFIG_EDIT_FAILED", 
        "VM_CONFIG_DISCREPANCY", 
        "VM_NODE_REFRESH_FAILED", 
        "VM_PLACEMENT_REFRESH_FAILED", 
        "REGISTRATION_TIMEDOUT", 
        "REPLACE_FAILED", 
        "UPLINK_FROM_TEAMING_POLICY_NOT_MAPPED", 
        "LOGICAL_SWITCH_NAMED_TEAMING_HAS_NO_PNIC_BACKING", 
        "DELETE_VM_IN_REDEPLOY_FAILED", 
        "DEPLOY_VM_IN_REDEPLOY_FAILED", 
        "INSUFFICIENT_RESOURCES_IN_EDGE_NODE_FOR_SERVICE"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Overall state of desired configuration", 
      "type": "string"
    }
  }, 
  "title": "Describes status of configuration of an entity", 
  "type": "object"
}

ConfigurationStateElement (type)

{
  "id": "ConfigurationStateElement", 
  "module_id": "Common", 
  "properties": {
    "failure_code": {
      "readonly": true, 
      "required": false, 
      "title": "Error code", 
      "type": "integer"
    }, 
    "failure_message": {
      "readonly": true, 
      "required": false, 
      "title": "Error message in case of failure", 
      "type": "string"
    }, 
    "state": {
      "enum": [
        "in_progress", 
        "success", 
        "failed", 
        "partial_success", 
        "in_sync", 
        "VM_DEPLOYMENT_FAILED", 
        "VM_POWER_ON_FAILED", 
        "VM_POWER_OFF_FAILED", 
        "VM_UNDEPLOY_FAILED", 
        "REPLACE_FAILED", 
        "UPLINK_FROM_TEAMING_POLICY_NOT_MAPPED", 
        "LOGICAL_SWITCH_NAMED_TEAMING_HAS_NO_PNIC_BACKING", 
        "DELETE_VM_IN_REDEPLOY_FAILED", 
        "DEPLOY_VM_IN_REDEPLOY_FAILED", 
        "INSUFFICIENT_RESOURCES_IN_EDGE_NODE_FOR_SERVICE", 
        "EDGE_CONFIG_ERROR", 
        "REGISTRATION_FAILED", 
        "TRANSPORT_NODE_CONFIGURATION_MISSING", 
        "EDGE_HARDWARE_NOT_SUPPORTED", 
        "MULTIPLE_OVERLAY_TZS_NOT_SUPPORTED", 
        "TN_OVERLAY_TZ_IN_USE_BY_EDGE_CLUSTER", 
        "TZ_ENDPOINTS_NOT_SPECIFIED", 
        "NO_PNIC_PREPARED_IN_EDGE", 
        "APPLIANCE_INTERNAL_ERROR", 
        "VTEP_DHCP_NOT_SUPPORTED", 
        "UNSUPPORTED_HOST_SWITCH_PROFILE", 
        "UPLINK_HOST_SWITCH_PROFILE_NOT_SPECIFIED", 
        "HOSTSWITCH_PROFILE_NOT_FOUND", 
        "LLDP_SEND_ENABLED_NOT_SUPPORTED", 
        "UNSUPPORTED_NAMED_TEAMING_POLICY", 
        "LBSRCID_NOT_SUPPORTED_FOR_EDGE_VM", 
        "LACP_NOT_SUPPORTED_FOR_EDGE_VM", 
        "STANDBY_UPLINKS_NOT_SUPPORTED_FOR_EDGE_VM", 
        "MULTIPLE_ACTIVE_UPLINKS_NOT_SUPPORTED_FOR_EDGE", 
        "UNSUPPORTED_LACP_LB_ALGO_FOR_NODE", 
        "EDGE_NODE_VERSION_NOT_SUPPORTED", 
        "NO_PNIC_SPECIFIED_IN_TN", 
        "INVALID_PNIC_DEVICE_NAME", 
        "UNSUPPORTED_DEFAULT_TEAMING_POLICY", 
        "MPA_DISCONNECTED", 
        "VM_NETWORK_EDIT_PENDING", 
        "VM_RENAME_PENDING", 
        "VM_CONFIG_EDIT_PENDING", 
        "VM_NETWORK_EDIT_FAILED", 
        "VM_RENAME_FAILED", 
        "VM_CONFIG_EDIT_FAILED", 
        "VM_CONFIG_DISCREPANCY", 
        "VM_NODE_REFRESH_FAILED", 
        "VM_PLACEMENT_REFRESH_FAILED", 
        "NOT_AVAILABLE", 
        "REGISTRATION_TIMEDOUT", 
        "pending", 
        "orphaned", 
        "unknown", 
        "error"
      ], 
      "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_name": {
      "readonly": true, 
      "required": false, 
      "title": "Name of backing resource on sub system", 
      "type": "string"
    }, 
    "sub_system_type": {
      "readonly": true, 
      "required": false, 
      "title": "Type of backing resource on sub system", 
      "type": "string"
    }
  }, 
  "title": "Describes status of configuration of an entity", 
  "type": "object"
}

ConflictingEntityListResponse (type)

{
  "additionalProperties": false, 
  "id": "ConflictingEntityListResponse", 
  "module_id": "GmConfigOnboarding", 
  "properties": {
    "example": {
      "$ref": "OnboardingFeatureInfo, 
      "description": "Conflict example", 
      "readonly": true, 
      "required": false, 
      "title": "Conflict example"
    }, 
    "feature_compability_data": {
      "items": {
        "$ref": "FeatureCompatibilityInfo
      }, 
      "maxItems": 100, 
      "readonly": true, 
      "required": false, 
      "type": "array"
    }, 
    "feature_descendants": {
      "items": {
        "$ref": "FeatureConflictInfo
      }, 
      "readonly": true, 
      "required": false, 
      "type": "array"
    }, 
    "feature_summary": {
      "$ref": "FeatureSummary, 
      "readonly": true, 
      "required": false
    }, 
    "infra_descendants": {
      "items": {
        "$ref": "FeatureConflictInfo
      }, 
      "readonly": true, 
      "required": false, 
      "type": "array"
    }
  }, 
  "title": "List of Features with conflict information", 
  "type": "object"
}

ConjunctionOperator (type)

{
  "additionalProperties": false, 
  "description": "Represents the operators AND or OR.", 
  "extends": {
    "$ref": "Expression
  }, 
  "id": "ConjunctionOperator", 
  "module_id": "Policy", 
  "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: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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", 
        "ExternalIDExpression", 
        "PathExpression", 
        "IdentityGroupExpression"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Represents the operators AND or OR", 
  "type": "object"
}

ConnectivityAdvancedConfig (type)

{
  "additionalProperties": false, 
  "id": "ConnectivityAdvancedConfig", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "connectivity": {
      "default": "ON", 
      "description": "Connectivity configuration to manually connect (ON) or disconnect (OFF) a Tier1 segment from corresponding Tier1 gateway. Only valid for Tier1 Segments. This property is ignored for L2 VPN extended segments when subnets property is not specified.", 
      "enum": [
        "ON", 
        "OFF"
      ], 
      "required": false, 
      "title": "Connectivity configuration", 
      "type": "string"
    }
  }, 
  "title": "Advanced configuration for Policy connectivity", 
  "type": "object"
}

ConsolidatedAPIListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "ConsolidatedAPIListRequestParameters", 
  "module_id": "GroupingObjectsProviders", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "ip_filter": {
      "$ref": "IPElement, 
      "description": "This filter can be used to verify an ip membership in the effective results", 
      "required": false, 
      "title": "An IPAddress or subnet for filtering the results."
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "site_id": {
      "required": false, 
      "title": "UUID of the site from which the effective IP addresses are to be fetched\n", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Consolidated effective IP addresses API list request parameters", 
  "type": "object"
}

ConsolidatedEffectiveIPAddressMemberListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ConsolidatedEffectiveIPAddressMemberListResult", 
  "module_id": "GroupingObjectsProviders", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "EffectiveIPInfo
      }, 
      "required": true, 
      "title": "Paged Collection of site wise consolidated effective ip addresses for the given NSGroup", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ConsolidatedEffectiveIPListRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "List request params for the pass through type api that get data from the Enforcement point. Enforcement point is mandatory for this request.", 
  "extends": {
    "$ref": "ConsolidatedAPIListRequestParameters
  }, 
  "id": "ConsolidatedEffectiveIPListRequestParameters", 
  "module_id": "PolicyGroupRealization", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "enforcement_point_path": {
      "description": "The path of the enforcement point on which the API needs to be executed. Forward slashes must be escaped using %2F.", 
      "required": false, 
      "title": "String Path of the enforcement point", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "ip_filter": {
      "$ref": "IPElement, 
      "description": "This filter can be used to verify an ip membership in the effective results", 
      "required": false, 
      "title": "An IPAddress or subnet for filtering the results."
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "site_id": {
      "required": false, 
      "title": "UUID of the site from which the effective IP addresses are to be fetched\n", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Consolidated API Realization list request params", 
  "type": "object"
}

ConsolidatedRealizedStatus (type)

{
  "additionalProperties": false, 
  "description": "Consolidated Realized Status of an intent object across enforcement points.", 
  "extends": {
    "$ref": "AggregatePolicyRuntimeInfo
  }, 
  "id": "ConsolidatedRealizedStatus", 
  "module_id": "PolicyRealizedState", 
  "properties": {
    "consolidated_status": {
      "$ref": "ConsolidatedStatus, 
      "description": "Consolidated Realized Status across enforcement points.", 
      "readonly": true, 
      "title": "Consolidated Realized Status"
    }, 
    "consolidated_status_per_enforcement_point": {
      "description": "List of Consolidated Realized Status per enforcement point.", 
      "items": {
        "$ref": "ConsolidatedStatusPerEnforcementPoint
      }, 
      "readonly": true, 
      "title": "List of Consolidated Realized Status per Enforcement Point", 
      "type": "array"
    }, 
    "intent_path": {
      "description": "Intent path of object, forward slashes must be escaped using %2F.", 
      "readonly": true, 
      "required": true, 
      "title": "String Path of the intent object", 
      "type": "string"
    }, 
    "intent_version": {
      "description": "Represent highest intent version across all realized objects", 
      "readonly": true, 
      "title": "Intent version for the status", 
      "type": "string"
    }, 
    "publish_status": {
      "enum": [
        "UNAVAILABLE", 
        "UNREALIZED", 
        "REALIZED", 
        "ERROR"
      ], 
      "required": true, 
      "title": "Aggregated Realization state of this object", 
      "type": "string"
    }
  }, 
  "title": "Consolidated Realized Status for an Intent Object", 
  "type": "object"
}

ConsolidatedStatus (type)

{
  "additionalProperties": false, 
  "description": "Consolidated Status of an intent object. Status Consolidation of an intent happens at multiple levels: - Per Enforcement Point: calculation of the consolidated status is performed using all realized entities that the intent objet maps to on a specific enforcement point. - Across Enforcement Points: calculation of the consolidated status is performend aggregating the consolidated status from each enforcement point.", 
  "id": "ConsolidatedStatus", 
  "module_id": "PolicyRealizedState", 
  "properties": {
    "consolidated_status": {
      "$ref": "ConfigState, 
      "description": "Consolidated Realized Status of an intent object.", 
      "readonly": true, 
      "title": "Consolidated Realized Status"
    }
  }, 
  "title": "Consolidated Status", 
  "type": "object"
}

ConsolidatedStatusNsxT (type)

{
  "additionalProperties": false, 
  "description": "Detailed Realized Status of an intent object on an NSX-T type of enforcement point.", 
  "extends": {
    "$ref": "ConsolidatedStatusPerEnforcementPoint
  }, 
  "id": "ConsolidatedStatusNsxT", 
  "module_id": "PolicyRealizationStatus", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ConsolidatedStatusNsxT"
  }, 
  "properties": {
    "alarm": {
      "$ref": "PolicyRuntimeAlarm, 
      "description": "Alarm information details.", 
      "readonly": true, 
      "title": "Alarm Information Details"
    }, 
    "consolidated_status": {
      "$ref": "ConsolidatedStatus, 
      "description": "Consolidated Realized Status of an Intent object per enforcement point.", 
      "readonly": true, 
      "title": "Consolidated Realized Status"
    }, 
    "enforced_status": {
      "$ref": "EnforcedStatusDetailsNsxT, 
      "description": "Detailed Realized Status inherent to an NSX-T Enforcement Point.", 
      "readonly": true, 
      "title": "Enforced Realized Status"
    }, 
    "enforcement_point_id": {
      "description": "Enforcement Point Id.", 
      "readonly": true, 
      "title": "Enforcement Point Id", 
      "type": "string"
    }, 
    "enforcement_point_path": {
      "description": "Policy Path referencing the enforcement point where the info is fetched.", 
      "readonly": true, 
      "title": "Enforcement point Path", 
      "type": "string"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "site_path": {
      "description": "The site where this enforcement point resides.", 
      "readonly": true, 
      "title": "Site Path", 
      "type": "string"
    }
  }, 
  "title": "NSX-T Consolidated Status", 
  "type": "object"
}

ConsolidatedStatusPerEnforcementPoint (type)

{
  "additionalProperties": false, 
  "description": "Consolidated Realized Status Per Enforcement Point.", 
  "extends": {
    "$ref": "BaseConsolidatedStatusPerEnforcementPoint
  }, 
  "id": "ConsolidatedStatusPerEnforcementPoint", 
  "module_id": "PolicyRealizedState", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ConsolidatedStatusPerEnforcementPoint"
  }, 
  "properties": {
    "alarm": {
      "$ref": "PolicyRuntimeAlarm, 
      "description": "Alarm information details.", 
      "readonly": true, 
      "title": "Alarm Information Details"
    }, 
    "consolidated_status": {
      "$ref": "ConsolidatedStatus, 
      "description": "Consolidated Realized Status of an Intent object per enforcement point.", 
      "readonly": true, 
      "title": "Consolidated Realized Status"
    }, 
    "enforcement_point_id": {
      "description": "Enforcement Point Id.", 
      "readonly": true, 
      "title": "Enforcement Point Id", 
      "type": "string"
    }, 
    "enforcement_point_path": {
      "description": "Policy Path referencing the enforcement point where the info is fetched.", 
      "readonly": true, 
      "title": "Enforcement point Path", 
      "type": "string"
    }, 
    "resource_type": {
      "required": true, 
      "type": "string"
    }, 
    "site_path": {
      "description": "The site where this enforcement point resides.", 
      "readonly": true, 
      "title": "Site Path", 
      "type": "string"
    }
  }, 
  "title": "Consolidated Realized Status Per Enforcement Point", 
  "type": "object"
}

ConstantFieldValue (type)

{
  "additionalProperties": false, 
  "description": "Constant Field Value.", 
  "extends": {
    "$ref": "FieldSettingValue
  }, 
  "id": "ConstantFieldValue", 
  "module_id": "PolicyReaction", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ConstantFieldValue"
  }, 
  "properties": {
    "constant": {
      "description": "Constant Value that the field must be set to.", 
      "title": "Constant Value", 
      "type": "object"
    }, 
    "resource_type": {
      "description": "Field Setting Value resource type.", 
      "enum": [
        "ConstantFieldValue"
      ], 
      "required": true, 
      "title": "Resource Type", 
      "type": "string"
    }
  }, 
  "title": "Constant Field Value", 
  "type": "object"
}

Constraint (type)

{
  "additionalProperties": false, 
  "description": "Constraint object to constraint any attribute on a resource based on specified expression. Example- Restrict the allowed services in Edge Communication Entry to list of  services, if the destinationGroups contain vCenter. {   \"target\":{      \"target_resource_type\":\"CommunicationEntry\",      \"attribute\":\"services\",      \"path_prefix\":\"/infra/domains/vmc-domain/edge-communication-maps/default/communication-entries\"   }   \"constraint_expression\":{     \"related_attribute\":{       \"attribute\":\"destinationGroups\"     }     \"condition\":{       \"operator\":\"INCLUDES\",       \"rhs_value\":{\"vCenter\"}       \"value_constraint\":{           \"operator\":\"ALLOW\",           \"values\":{\"/ref/services/HTTPS\", \"/ref/services/HTTOP\", ...}      }     }   } }", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "Constraint", 
  "module_id": "PolicyConstraints", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "constraint_expression": {
      "$ref": "ConstraintExpression, 
      "required": true, 
      "title": "Expression to constrain the target attribute value."
    }, 
    "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "message": {
      "required": false, 
      "title": "User friendly message to be shown to users upon violation.", 
      "type": "string"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "target": {
      "$ref": "ConstraintTarget, 
      "required": true, 
      "title": "Target resource attribute details."
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Constraint definition.", 
  "type": "object"
}

ConstraintExpression (type)

{
  "abstract": true, 
  "description": "All the types of the expression extend from this abstract class. This is present for extensibility.", 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "ConstraintExpression", 
  "module_id": "PolicyConstraints", 
  "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: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "resource_type": {
      "enum": [
        "ValueConstraintExpression", 
        "RelatedAttributeConditionalExpression", 
        "EntityInstanceCountConstraintExpression", 
        "FieldSanityConstraintExpression"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Base class for constraint expression", 
  "type": "object"
}

ConstraintListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ConstraintListResult", 
  "module_id": "PolicyConstraints", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "Constraint
      }, 
      "required": true, 
      "title": "Constraint list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of Constraints", 
  "type": "object"
}

ConstraintTarget (type)

{
  "additionalProperties": false, 
  "description": "Resource attribute on which constraint should be applied. Example - sourceGroups attribute of Edge CommunicationEntry to be   restricted, is given as:   {      \"target_resource_type\":\"CommunicationEntry\",      \"attribute\":\"sourceGroups\",      \"path_prefix\":\"/infra/domains/vmc-domain/edge-communication-maps/default/communication-entries\"   }", 
  "id": "ConstraintTarget", 
  "module_id": "PolicyConstraints", 
  "properties": {
    "attribute": {
      "required": false, 
      "title": "Attribute name of the target entity.", 
      "type": "string"
    }, 
    "path_prefix": {
      "required": false, 
      "title": "Path prefix of the entity to apply constraint.\nThis is required to further disambiguiate if multiple policy entities\nshare the same resource type.\nExample - Edge FW and DFW use the same resource type CommunicationMap,\nCommunicationEntry, Group, etc.\n", 
      "type": "string"
    }, 
    "target_resource_type": {
      "required": true, 
      "title": "Resource type of the target entity.", 
      "type": "string"
    }
  }, 
  "title": "Resource attribute on which constraint should be applied.", 
  "type": "object"
}

ContainerApplication (type)

{
  "description": "Container application within a project.", 
  "extends": {
    "$ref": "DiscoveredResource
  }, 
  "id": "ContainerApplication", 
  "module_id": "InventoryContainerObj", 
  "properties": {
    "_last_sync_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "container_cluster_id": {
      "description": "Identifier of the container cluster this container application belongs to.", 
      "readonly": true, 
      "required": false, 
      "title": "Identifier of the container cluster", 
      "type": "string"
    }, 
    "container_project_id": {
      "description": "Identifier of the project which this container application belongs to.", 
      "readonly": false, 
      "required": false, 
      "title": "Identifier of the project", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "external_id": {
      "description": "Identifier of the container application on container cluster e.g. PCF app id, k8s service id.", 
      "readonly": false, 
      "required": true, 
      "title": "External identifier of the container application", 
      "type": "string"
    }, 
    "network_errors": {
      "description": "List of network errors related to container application.", 
      "items": {
        "$ref": "NetworkError
      }, 
      "readonly": false, 
      "required": false, 
      "title": "Network errors", 
      "type": "array"
    }, 
    "network_status": {
      "description": "Network status of container application.", 
      "enum": [
        "HEALTHY", 
        "UNHEALTHY"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "Network status of container application", 
      "type": "string"
    }, 
    "origin_properties": {
      "description": "Array of additional specific properties of container application in key-value format.", 
      "items": {
        "$ref": "KeyValuePair
      }, 
      "readonly": false, 
      "required": false, 
      "title": "Origin properties", 
      "type": "array"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }, 
    "status": {
      "description": "Status of the container application.", 
      "enum": [
        "UNKNOWN", 
        "HEALTHY", 
        "UP", 
        "DOWN", 
        "DEGRADED"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "Status of the container application", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Container application within a project", 
  "type": "object"
}

ContainerApplicationInstance (type)

{
  "description": "Container application instance within a project.", 
  "extends": {
    "$ref": "DiscoveredResource
  }, 
  "id": "ContainerApplicationInstance", 
  "module_id": "InventoryContainerObj", 
  "properties": {
    "_last_sync_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cluster_node_id": {
      "description": "Cluster node id where application instance is running.", 
      "readonly": false, 
      "required": false, 
      "title": "Cluster node id", 
      "type": "string"
    }, 
    "container_application_ids": {
      "description": "List of identifiers of the container application.", 
      "items": {
        "type": "string"
      }, 
      "readonly": false, 
      "required": false, 
      "title": "Identifiers of the container application", 
      "type": "array"
    }, 
    "container_cluster_id": {
      "description": "Identifier of the container cluster this application instance belongs to.", 
      "readonly": true, 
      "required": false, 
      "title": "Identifier of the container cluster", 
      "type": "string"
    }, 
    "container_project_id": {
      "description": "Identifier of the container project which this container application instance belongs to.", 
      "readonly": false, 
      "required": false, 
      "title": "Identifier of the project", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "external_id": {
      "description": "Identifier of the container application instance on container cluster.", 
      "readonly": false, 
      "required": true, 
      "title": "External identifier of the container application instance", 
      "type": "string"
    }, 
    "network_errors": {
      "description": "List of network errors related to container application instance.", 
      "items": {
        "$ref": "NetworkError
      }, 
      "readonly": false, 
      "required": false, 
      "title": "Network errors", 
      "type": "array"
    }, 
    "network_status": {
      "description": "Network status of container application instance.", 
      "enum": [
        "HEALTHY", 
        "UNHEALTHY"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "Network status of container application instance", 
      "type": "string"
    }, 
    "origin_properties": {
      "description": "Array of additional specific properties of container application instance in key-value format.", 
      "items": {
        "$ref": "KeyValuePair
      }, 
      "readonly": false, 
      "required": false, 
      "title": "Origin properties", 
      "type": "array"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }, 
    "status": {
      "description": "Status of the container application instance.", 
      "enum": [
        "UNKNOWN", 
        "HEALTHY", 
        "UP", 
        "DOWN", 
        "DEGRADED"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "Status of the container application instance", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Container Application Instance", 
  "type": "object"
}

ContainerCluster (type)

{
  "description": "Details of container cluster.", 
  "extends": {
    "$ref": "DiscoveredResource
  }, 
  "id": "ContainerCluster", 
  "module_id": "InventoryContainerObj", 
  "properties": {
    "_last_sync_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cluster_type": {
      "description": "Type of the container cluster. In case of creating container cluster first time, it is expected to pass the valid cluster-type. In case of update, if there is no change in cluster-type, then this field can be omitted in the request.", 
      "enum": [
        "PAS", 
        "PKS", 
        "Kubernetes", 
        "Openshift", 
        "WCP", 
        "WCP_Guest", 
        "Other"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "Type of the container cluster", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "external_id": {
      "description": "External identifier of the container cluster.", 
      "readonly": false, 
      "required": false, 
      "title": "External identifier of the container cluster", 
      "type": "string"
    }, 
    "infrastructure": {
      "$ref": "ContainerInfrastructureInfo, 
      "description": "Details of underlying infrastructure that hosts the container cluster. In case of creating container cluster first time, it is expected to pass the valid infrastructure. In case of update, if there is no change in cluster-type, then this field can be omitted in the request.", 
      "readonly": false, 
      "required": false, 
      "title": "Details of infrastructure for the container cluster"
    }, 
    "network_errors": {
      "description": "List of network errors related to container cluster.", 
      "items": {
        "$ref": "NetworkError
      }, 
      "readonly": false, 
      "required": false, 
      "title": "Network errors", 
      "type": "array"
    }, 
    "network_status": {
      "description": "Network status of container cluster.", 
      "enum": [
        "HEALTHY", 
        "UNHEALTHY"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "Network status of container cluster", 
      "type": "string"
    }, 
    "origin_properties": {
      "description": "Array of additional specific properties of container cluster in key-value format.", 
      "items": {
        "$ref": "KeyValuePair
      }, 
      "readonly": false, 
      "required": false, 
      "title": "Origin properties", 
      "type": "array"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Container cluster", 
  "type": "object"
}

ContainerClusterNode (type)

{
  "description": "Details of container cluster node i.e. container host.", 
  "extends": {
    "$ref": "DiscoveredResource
  }, 
  "id": "ContainerClusterNode", 
  "module_id": "InventoryContainerObj", 
  "properties": {
    "_last_sync_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "container_cluster_id": {
      "description": "External identifier of the container cluster.", 
      "readonly": false, 
      "required": false, 
      "title": "External identifier of the container cluster", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "external_id": {
      "description": "External identifier of the container cluster node in K8S/PAS.", 
      "readonly": false, 
      "required": true, 
      "title": "External identifier of the container cluster node", 
      "type": "string"
    }, 
    "ip_addresses": {
      "description": "List of IP addresses of container cluster node.", 
      "items": {
        "$ref": "IPAddress
      }, 
      "readonly": false, 
      "required": false, 
      "title": "IP Addresses of Node", 
      "type": "array"
    }, 
    "network_errors": {
      "description": "List of network errors related to container cluster node.", 
      "items": {
        "$ref": "NetworkError
      }, 
      "readonly": false, 
      "required": false, 
      "title": "Network errors", 
      "type": "array"
    }, 
    "network_status": {
      "description": "Network status of container cluster node.", 
      "enum": [
        "HEALTHY", 
        "UNHEALTHY"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "Network status of container cluster node", 
      "type": "string"
    }, 
    "origin_properties": {
      "description": "Array of additional specific properties of container cluster node in key-value format.", 
      "items": {
        "$ref": "KeyValuePair
      }, 
      "readonly": false, 
      "required": false, 
      "title": "Origin properties", 
      "type": "array"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Container cluster node", 
  "type": "object"
}

ContainerConfiguration (type)

{
  "additionalProperties": false, 
  "description": "Represents a container to group widgets that belong to a common category or have a common purpose.", 
  "extends": {
    "$ref": "WidgetConfiguration
  }, 
  "id": "ContainerConfiguration", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ContainerConfiguration"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "datasources": {
      "description": "The 'datasources' represent the sources from which data will be fetched. Currently, only NSX-API is supported as a 'default' datasource. An example of specifying 'default' datasource along with the urls to fetch data from is given at 'example_request' section of 'CreateWidgetConfiguration' API.", 
      "items": {
        "$ref": "Datasource
      }, 
      "minItems": 0, 
      "title": "Array of Datasource Instances with their relative urls", 
      "type": "array"
    }, 
    "default_filter_value": {
      "description": "Default filter values to be passed to datasources. This will be used when the report is requested without filter values.", 
      "items": {
        "$ref": "DefaultFilterValue
      }, 
      "title": "Default filter value to be passed to datasources", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "description": "Title of the widget. If display_name is omitted, the widget will be shown without a title.", 
      "maxLength": 255, 
      "title": "Widget Title", 
      "type": "string"
    }, 
    "drilldown_id": {
      "description": "Id of drilldown widget, if any. Id should be a valid id of an existing widget. A widget is considered as drilldown widget when it is associated with any other widget and provides more detailed information about any data item from the parent widget.", 
      "maxLength": 255, 
      "title": "Id of drilldown widget", 
      "type": "string"
    }, 
    "feature_set": {
      "$ref": "FeatureSet, 
      "description": "Features required to view the widget.", 
      "title": "Features required to view the widget"
    }, 
    "filter": {
      "description": "Id of filter widget for subscription, if any. Id should be a valid id of an existing filter widget. Filter widget should be from the same view. Datasource URLs should have placeholder values equal to filter alias to accept the filter value on filter change.", 
      "title": "Id of filter widget for subscription", 
      "type": "string"
    }, 
    "filter_value_required": {
      "default": true, 
      "description": "Flag to indicate that widget will continue to work without filter value. If this flag is set to false then default_filter_value is manadatory.", 
      "title": "Flag to indicate if filter value is necessary", 
      "type": "boolean"
    }, 
    "footer": {
      "$ref": "Footer
    }, 
    "header": {
      "$ref": "Header
    }, 
    "icons": {
      "description": "Icons to be applied at dashboard for widgets and UI elements.", 
      "items": {
        "$ref": "Icon
      }, 
      "title": "Icons", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "is_drilldown": {
      "default": false, 
      "description": "Set to true if this widget should be used as a drilldown.", 
      "title": "Set as a drilldown widget", 
      "type": "boolean"
    }, 
    "labels": {
      "description": "Labels for the container.", 
      "items": {
        "$ref": "Label
      }, 
      "minItems": 0, 
      "title": "Labels", 
      "type": "array"
    }, 
    "layout": {
      "$ref": "Layout, 
      "description": "Layout of widgets can be either vertical or horizontal. If layout is not specified a default horizontal layout is applied.", 
      "title": "Layout of widgets inside container"
    }, 
    "legend": {
      "$ref": "Legend, 
      "description": "Legend to be displayed. If legend is not needed, do not include it.", 
      "title": "Legend for the widget"
    }, 
    "navigation": {
      "description": "Hyperlink of the specified UI page that provides details.", 
      "maxLength": 1024, 
      "title": "Navigation to a specified UI page", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "Supported visualization types are LabelValueConfiguration, DonutConfiguration, GridConfiguration, StatsConfiguration, MultiWidgetConfiguration, GraphConfiguration, ContainerConfiguration, CustomWidgetConfiguration and DropdownFilterWidgetConfiguration.", 
      "enum": [
        "LabelValueConfiguration", 
        "DonutConfiguration", 
        "MultiWidgetConfiguration", 
        "ContainerConfiguration", 
        "StatsConfiguration", 
        "GridConfiguration", 
        "GraphConfiguration", 
        "CustomWidgetConfiguration", 
        "DropdownFilterWidgetConfiguration"
      ], 
      "maxLength": 255, 
      "readonly": true, 
      "required": true, 
      "title": "Widget visualization type", 
      "type": "string"
    }, 
    "shared": {
      "deprecated": true, 
      "description": "Please use the property 'shared' of View instead of this. The widgets of a shared view are visible to other users.", 
      "title": "Visiblity of widgets to other users", 
      "type": "boolean"
    }, 
    "span": {
      "description": "Represents the horizontal span of the widget / container.", 
      "maximum": 12, 
      "minimum": 1, 
      "title": "Horizontal span", 
      "type": "int"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "weight": {
      "deprecated": true, 
      "description": "Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details.", 
      "title": "Weightage or placement of the widget or container", 
      "type": "int"
    }, 
    "widgets": {
      "description": "If not specified, creates an empty container.", 
      "items": {
        "$ref": "WidgetItem
      }, 
      "minItems": 0, 
      "title": "Widgets held by the container", 
      "type": "array"
    }
  }, 
  "title": "Container that holds widgets", 
  "type": "object"
}

ContainerInfrastructureInfo (type)

{
  "description": "Details of infrastructure hosting the container cluster e.g. vSphere, AWS, VMC etc..", 
  "id": "ContainerInfrastructureInfo", 
  "module_id": "InventoryContainerObj", 
  "properties": {
    "infra_type": {
      "description": "Type of the infrastructure.", 
      "enum": [
        "vSphere", 
        "AWS", 
        "Azure", 
        "VMC", 
        "KVM", 
        "Baremetal"
      ], 
      "readonly": false, 
      "required": true, 
      "title": "Type of the infrastructure", 
      "type": "string"
    }
  }, 
  "title": "Details of container infrastructure", 
  "type": "object"
}

ContainerIngressPolicy (type)

{
  "description": "Details of Container Ingress Policy.", 
  "extends": {
    "$ref": "DiscoveredResource
  }, 
  "id": "ContainerIngressPolicy", 
  "module_id": "InventoryContainerObj", 
  "properties": {
    "_last_sync_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "container_application_ids": {
      "description": "List of identifiers of the container application , on which ingress policy is applied. e.g. IDs of all services on which the ingress is applied in kubernetes.", 
      "items": {
        "type": "string"
      }, 
      "readonly": false, 
      "required": false, 
      "title": "Identifiers of the container application", 
      "type": "array"
    }, 
    "container_cluster_id": {
      "description": "Identifier of the container cluster this ingress policy belongs to.", 
      "readonly": false, 
      "required": false, 
      "title": "Identifier of the container cluster", 
      "type": "string"
    }, 
    "container_project_id": {
      "description": "Identifier of the project which this container ingress belongs to.", 
      "readonly": false, 
      "required": false, 
      "title": "Identifier of the project", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "external_id": {
      "description": "Identifier of the container ingress policy.", 
      "readonly": false, 
      "required": true, 
      "title": "External identifier of the container ingress policy", 
      "type": "string"
    }, 
    "network_errors": {
      "description": "List of network errors related to container ingress.", 
      "items": {
        "$ref": "NetworkError
      }, 
      "readonly": false, 
      "required": false, 
      "title": "Network errors", 
      "type": "array"
    }, 
    "network_status": {
      "description": "Network status of container ingress.", 
      "enum": [
        "HEALTHY", 
        "UNHEALTHY"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "Network status of container ingress", 
      "type": "string"
    }, 
    "origin_properties": {
      "description": "Array of additional specific properties of container ingress in key-value format.", 
      "items": {
        "$ref": "KeyValuePair
      }, 
      "readonly": false, 
      "required": false, 
      "title": "Origin properties", 
      "type": "array"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }, 
    "spec": {
      "description": "Container ingress policy specification.", 
      "readonly": false, 
      "required": false, 
      "title": "Container ingress policy specification", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Container Ingress Policy", 
  "type": "object"
}

ContainerNetworkPolicy (type)

{
  "description": "Network policy applied to container.", 
  "extends": {
    "$ref": "DiscoveredResource
  }, 
  "id": "ContainerNetworkPolicy", 
  "module_id": "InventoryContainerObj", 
  "properties": {
    "_last_sync_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "container_cluster_id": {
      "description": "Identifier of the container cluster this network policy belongs to.", 
      "readonly": false, 
      "required": false, 
      "title": "Identifier of the container cluster", 
      "type": "string"
    }, 
    "container_project_id": {
      "description": "Identifier of the project which this network policy belongs to.", 
      "readonly": false, 
      "required": false, 
      "title": "Identifier of the project", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "external_id": {
      "description": "Identifier of the container network policy.", 
      "readonly": false, 
      "required": true, 
      "title": "External identifier of the container network policy", 
      "type": "string"
    }, 
    "network_errors": {
      "description": "List of network errors related to container network policy.", 
      "items": {
        "$ref": "NetworkError
      }, 
      "readonly": false, 
      "required": false, 
      "title": "Network errors", 
      "type": "array"
    }, 
    "network_status": {
      "description": "Network status of container network policy.", 
      "enum": [
        "HEALTHY", 
        "UNHEALTHY"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "Network status of container network policy", 
      "type": "string"
    }, 
    "origin_properties": {
      "description": "Array of additional specific properties of container network policy in key-value format.", 
      "items": {
        "$ref": "KeyValuePair
      }, 
      "readonly": false, 
      "required": false, 
      "title": "Origin properties", 
      "type": "array"
    }, 
    "policy_type": {
      "description": "Type e.g. Network Policy, ASG.", 
      "enum": [
        "NETWORK_POLICY", 
        "ASG"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "Type", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }, 
    "spec": {
      "description": "Container network policy specification.", 
      "readonly": false, 
      "required": false, 
      "title": "Container network policy specification", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Container Network Policy", 
  "type": "object"
}

ContainerProject (type)

{
  "description": "Details of org/namespace within a container cluster.", 
  "extends": {
    "$ref": "DiscoveredResource
  }, 
  "id": "ContainerProject", 
  "module_id": "InventoryContainerObj", 
  "properties": {
    "_last_sync_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "container_cluster_id": {
      "description": "Identifier of the container cluster to which this project/namespace belongs.", 
      "readonly": false, 
      "required": false, 
      "title": "Identifier of the container cluster", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "external_id": {
      "description": "External identifier of the container project.", 
      "readonly": false, 
      "required": true, 
      "title": "External identifier of the container project", 
      "type": "string"
    }, 
    "network_errors": {
      "description": "List of network errors related to container project.", 
      "items": {
        "$ref": "NetworkError
      }, 
      "readonly": false, 
      "required": false, 
      "title": "Network errors", 
      "type": "array"
    }, 
    "network_status": {
      "description": "Network status of container project.", 
      "enum": [
        "HEALTHY", 
        "UNHEALTHY"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "Network status of container project", 
      "type": "string"
    }, 
    "origin_properties": {
      "description": "Array of additional specific properties of container project in key-value format.", 
      "items": {
        "$ref": "KeyValuePair
      }, 
      "readonly": false, 
      "required": false, 
      "title": "Origin properties", 
      "type": "array"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Container project within a container cluster", 
  "type": "object"
}

ContentFilterValue (type)

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

ContextProfileAttributesMetadata (type)

{
  "additionalProperties": false, 
  "id": "ContextProfileAttributesMetadata", 
  "module_id": "PolicyContextProfile", 
  "properties": {
    "key": {
      "required": true, 
      "title": "Key for metadata", 
      "type": "string"
    }, 
    "value": {
      "required": true, 
      "title": "Value for metadata key", 
      "type": "string"
    }
  }, 
  "title": "Key value structure for holding metadata of context profile attributes", 
  "type": "object"
}

ContinueRequestParameters (type)

{
  "additionalProperties": false, 
  "id": "ContinueRequestParameters", 
  "module_id": "Upgrade", 
  "properties": {
    "component_type": {
      "description": "Hints NSX to upgrade a specific component.", 
      "readonly": false, 
      "required": false, 
      "title": "Component to upgrade.", 
      "type": "string"
    }, 
    "skip": {
      "default": false, 
      "readonly": false, 
      "required": false, 
      "title": "Skip to upgrade of next component.", 
      "type": "boolean"
    }
  }, 
  "type": "object"
}

CookiePersistenceModeType (type)

{
  "additionalProperties": false, 
  "description": "If the persistence cookie is found in the incoming request, value of the cookie is used to identify the server that this request should be sent to. If the cookie is not found, then the server selection algorithm is used to select a new server to handle that request. Three different modes of cookie persistence are supported: insert, prefix and rewrite. In cookie insert mode, a cookie is inserted by load balancer in the HTTP response going from server to client. In cookie prefix and rewrite modes, server controls the cookie and load balancer only manipulates the value of the cookie. In prefix mode, server's cookie value is prepended with the server IP and port and then sent to the client. In rewrite mode, entire server's cookie value is replaced with the server IP and port in the response before sending it to the client.", 
  "enum": [
    "INSERT", 
    "PREFIX", 
    "REWRITE"
  ], 
  "id": "CookiePersistenceModeType", 
  "module_id": "LoadBalancer", 
  "title": "cookie persistence mode", 
  "type": "string"
}

CopyFromRemoteFileProperties (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "CopyRemoteFileProperties
  }, 
  "id": "CopyFromRemoteFileProperties", 
  "properties": {
    "port": {
      "maximum": 65535, 
      "minimum": 1, 
      "title": "Server port", 
      "type": "integer"
    }, 
    "protocol": {
      "$ref": "Protocol, 
      "required": true, 
      "title": "Protocol to use to copy file"
    }, 
    "server": {
      "pattern": "^[^/:]+$", 
      "required": true, 
      "title": "Remote server hostname or IP address", 
      "type": "string"
    }, 
    "uri": {
      "required": true, 
      "title": "URI of file to copy", 
      "type": "string"
    }
  }, 
  "type": "object"
}

CopyRemoteFileProperties (type)

{
  "additionalProperties": {}, 
  "id": "CopyRemoteFileProperties", 
  "properties": {
    "port": {
      "maximum": 65535, 
      "minimum": 1, 
      "title": "Server port", 
      "type": "integer"
    }, 
    "server": {
      "pattern": "^[^/:]+$", 
      "required": true, 
      "title": "Remote server hostname or IP address", 
      "type": "string"
    }, 
    "uri": {
      "required": true, 
      "title": "URI of file to copy", 
      "type": "string"
    }
  }, 
  "type": "object"
}

CopyToRemoteFileProperties (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "CopyRemoteFileProperties
  }, 
  "id": "CopyToRemoteFileProperties", 
  "properties": {
    "port": {
      "maximum": 65535, 
      "minimum": 1, 
      "title": "Server port", 
      "type": "integer"
    }, 
    "protocol": {
      "$ref": "Protocol, 
      "description": "Only scp and sftp may be used.", 
      "required": true, 
      "title": "Protocol to use to copy file"
    }, 
    "server": {
      "pattern": "^[^/:]+$", 
      "required": true, 
      "title": "Remote server hostname or IP address", 
      "type": "string"
    }, 
    "uri": {
      "required": true, 
      "title": "URI of file to copy", 
      "type": "string"
    }
  }, 
  "type": "object"
}

CountActionArgument (type)

{
  "id": "CountActionArgument", 
  "module_id": "LiveTrace", 
  "properties": {
    "count_type": {
      "enum": [
        "ALL", 
        "INTERFACE_ONLY"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Type of count", 
      "type": "string"
    }
  }, 
  "type": "object"
}

CountActionConfig (type)

{
  "id": "CountActionConfig", 
  "module_id": "LiveTrace", 
  "properties": {
    "action_argument": {
      "$ref": "CountActionArgument, 
      "required": true, 
      "title": "The count action argument"
    }
  }, 
  "type": "object"
}

CpuUsage (type)

{
  "additionalProperties": false, 
  "id": "CpuUsage", 
  "module_id": "ApplianceStats", 
  "properties": {
    "avg_cpu_core_usage_dpdk": {
      "readonly": true, 
      "title": "Indicates the average usage of all DPDK cores in percentage.", 
      "type": "number"
    }, 
    "avg_cpu_core_usage_non_dpdk": {
      "description": "Indicates the average usage of all non-DPDK cores in percentage.", 
      "readonly": true, 
      "title": "Average usage of all non-DPDK cores", 
      "type": "number"
    }, 
    "highest_cpu_core_usage_dpdk": {
      "description": "Indicates the highest CPU utilization value among DPDK cores in percentage.", 
      "readonly": true, 
      "title": "Highest CPU utilization value among DPDK cores", 
      "type": "number"
    }, 
    "highest_cpu_core_usage_non_dpdk": {
      "description": "Indicates the highest cpu utilization value among non_dpdk cores in percentage.", 
      "readonly": true, 
      "title": "Highest CPU utilization value among non-DPDK cores", 
      "type": "number"
    }
  }, 
  "title": "CPU usage of DPDK and non-DPDK cores", 
  "type": "object"
}

CreateRemoteDirectoryProperties (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "CopyRemoteFileProperties
  }, 
  "id": "CreateRemoteDirectoryProperties", 
  "properties": {
    "port": {
      "maximum": 65535, 
      "minimum": 1, 
      "title": "Server port", 
      "type": "integer"
    }, 
    "protocol": {
      "$ref": "SftpProtocol, 
      "required": true, 
      "title": "Protocol to use to copy file"
    }, 
    "server": {
      "pattern": "^[^/:]+$", 
      "required": true, 
      "title": "Remote server hostname or IP address", 
      "type": "string"
    }, 
    "uri": {
      "required": true, 
      "title": "URI of file to copy", 
      "type": "string"
    }
  }, 
  "type": "object"
}

Criterion (type)

{
  "additionalProperties": false, 
  "description": "Event Criterion is the logical evaluations by which the event may be deemed fulfilled. All the evaluations must be met in order for the criterion to be met (implicit AND).", 
  "id": "Criterion", 
  "module_id": "PolicyReaction", 
  "properties": {
    "evaluations": {
      "description": "Criterion Evaluations.", 
      "items": {
        "$ref": "Evaluation
      }, 
      "minItems": 1, 
      "required": true, 
      "title": "Criterion Evaluations", 
      "type": "array"
    }
  }, 
  "title": "Event Criterion", 
  "type": "object"
}

CsvListResult (type)

{
  "abstract": true, 
  "description": "Base type for CSV result.", 
  "id": "CsvListResult", 
  "module_id": "CsvTypes", 
  "properties": {
    "file_name": {
      "description": "File name set by HTTP server if API  returns CSV result as a file.", 
      "required": false, 
      "title": "File name", 
      "type": "string"
    }
  }, 
  "type": "object"
}

CsvRecord (type)

{
  "abstract": true, 
  "description": "Base type for CSV records.", 
  "id": "CsvRecord", 
  "module_id": "CsvTypes", 
  "type": "object"
}

CurrentBackupOperationStatus (type)

{
  "additionalProperties": false, 
  "id": "CurrentBackupOperationStatus", 
  "module_id": "BackupConfiguration", 
  "properties": {
    "backup_id": {
      "required": false, 
      "title": "Unique identifier of current backup", 
      "type": "string"
    }, 
    "current_step": {
      "enum": [
        "BACKUP_CREATING_CLUSTER_BACKUP", 
        "BACKUP_CREATING_NODE_BACKUP"
      ], 
      "required": false, 
      "title": "Current step of operation", 
      "type": "string"
    }, 
    "current_step_message": {
      "required": false, 
      "title": "Additional human-readable status information about current step", 
      "type": "string"
    }, 
    "end_time": {
      "$ref": "EpochMsTimestamp, 
      "required": false, 
      "title": "Time when operation is expected to end"
    }, 
    "operation_type": {
      "enum": [
        "NONE", 
        "BACKUP"
      ], 
      "required": true, 
      "title": "Type of operation that is in progress. Returns none if no operation is in progress, in which case\nnone of the other fields will be set.\n", 
      "type": "string"
    }, 
    "start_time": {
      "$ref": "EpochMsTimestamp, 
      "required": false, 
      "title": "Time when operation was started"
    }
  }, 
  "title": "Current backup operation status", 
  "type": "object"
}

CustomAttributeAction (type)

{
  "additionalProperties": false, 
  "description": "Request Parameter which specify action to either add or remove the custom values.", 
  "id": "CustomAttributeAction", 
  "module_id": "PolicyContextProfile", 
  "properties": {
    "action": {
      "description": "Action parameter determines whether to add or remove Custom Context Profile Attribute values.", 
      "enum": [
        "add", 
        "remove"
      ], 
      "required": true, 
      "title": "Add or Remove Custom Context Profile Attribute values.", 
      "type": "string"
    }
  }, 
  "title": "Request Parameters for Custom Context Profile Attributes", 
  "type": "object"
}

CustomPolicyLbPersistenceProfile (type)

{
  "additionalProperties": false, 
  "description": "Some applications maintain state and require all relevant connections to be sent to the same server as the application state is not synchronized among servers. Persistence is enabled on a PolicyLbVirtualServer by binding a persistence profile to it.", 
  "extends": {
    "$ref": "PolicyLbPersistenceProfile
  }, 
  "id": "CustomPolicyLbPersistenceProfile", 
  "module_id": "TempPolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "CustomPolicyLbPersistenceProfile"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "persistence": {
      "description": "This field indicates the persistence method used for the PolicyLbVirtualServer. - COOKIE persistence allows related client connections, identified by the same cookie in HTTP requests [Refer to HTTP Cookie for details on HTTP cookies], to be redirected to the same server. Load balancer does not maintain any persistence table for cookie persistence. Instead, it encodes the necessary information in the HTTP cookie value sent to client and relies on the client to store it and send it back in subsequent related HTTP requests. Hence there is no limit on the number of cookie persistence entries that can be supported. - SOURCE_IP persistence ensures all connections from a client (identified by IP address) are sent to the same backend server for a specified period. - This object is not required and without creation of this object the virtual server persistence is disabled by default", 
      "enum": [
        "COOKIE", 
        "SOURCE_IP"
      ], 
      "required": true, 
      "title": "Persistence method used by PolicyLbVirtualServer(s)", 
      "type": "string"
    }, 
    "persistence_shared": {
      "default": false, 
      "description": "Persistence shared setting indicates that all PolicyLbVirtualServers that consume this PolicyLbPersistenceProfile should share the same persistence mechanism when enabled.  Meaning, persistence entries of a client accessing one virtual server will also affect the same client's connections to a different virtual server. For example, say there are two virtual servers vip-ip1:80 and vip-ip1:8080 bound to the same Group g1 consisting of two servers (s11:80 and s12:80). By default, each virtual server will have its own persistence table or cookie. So, in the earlier example, there will be two tables (vip-ip1:80, p1) and (vip-ip1:8080, p1) or cookies. So, if a client connects to vip1:80 and later connects to vip1:8080, the second connection may be sent to a different server than the first.  When persistence_shared is enabled, then the second connection will always connect to the same server as the original connection. For COOKIE persistence type, the same cookie will be shared by multiple virtual servers. For SOURCE_IP persistenct type, the persistence table will be shared across virtual servers.", 
      "required": false, 
      "title": "Persistence shared across PolicyLbVirtualServers", 
      "type": "boolean"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "enum": [
        "L4PolicyLbPersistenceProfile", 
        "L7PolicyLbPersistenceProfile", 
        "CustomPolicyLbPersistenceProfile"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "PolicyLbPersistenceProflie for Custom type PolicyLbVirtualServer", 
  "type": "object"
}

CustomPolicyLbVirtualServer (type)

{
  "additionalProperties": false, 
  "description": "Virtual server acts as a facade to an application, receives all client connections over a specified protocol and distributes them among the backend servers.  This custom type allows for more complex settings than the simplified PolicyLbVirtualServer types.  This object allows for complex configurations for PolicyLbVirtualServers of all types. All HTTP specific inputs will be rejected when combined with TPC or UDP protocols.", 
  "extends": {
    "$ref": "HttpPolicyLbVirtualServer
  }, 
  "id": "CustomPolicyLbVirtualServer", 
  "module_id": "TempPolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "CustomPolicyLbVirtualServer"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "access_log_enabled": {
      "default": false, 
      "description": "If access log is enabled, all HTTP requests sent to an L7 virtual server are logged to the access log file. Both successful requests (backend server returns 2xx) and unsuccessful requests (backend server returns 4xx or 5xx) are logged to access log, if enabled.", 
      "required": false, 
      "title": "Access log enabled setting", 
      "type": "boolean"
    }, 
    "app_protocol": {
      "description": "As the custom type allows for more complex settings than the simplified PolicyLbVirtualServer types, also specify the desired protocol for receiving all client connections.", 
      "enum": [
        "TCP", 
        "UDP", 
        "HTTP", 
        "HTTPS"
      ], 
      "required": true, 
      "title": "Application protocol for receiving client connections", 
      "type": "string"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "client_ssl_certificate_ids": {
      "description": "Client-side SSL profile binding allows multiple certificates, for different hostnames, to be bound to the same virtual server. The setting is used when load balancer acts as an SSL server and terminating the client SSL connection", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "ssl certificates", 
      "type": "array"
    }, 
    "client_ssl_settings": {
      "default": "HIGH_SECURE_111317", 
      "description": "Security settings representing various security settings when the VirtualServer acts as an SSL server - BASE_SECURE_111317 - MODERATE_SECURE_111317 - HIGH_SECURE_111317", 
      "enum": [
        "BASE_SECURE_111317", 
        "MODERATE_SECURE_111317", 
        "HIGH_SECURE_111317"
      ], 
      "required": false, 
      "title": "Security profile setting", 
      "type": "string"
    }, 
    "default_client_ssl_certificate_id": {
      "description": "The setting is used when load balancer acts as an SSL server and terminating the client SSL connection.  A default certificate should be specified which will be used if the server does not host multiple hostnames on the same IP address or if the client does not support SNI extension.", 
      "required": false, 
      "title": "ssl certificate", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "insert_client_ip_header": {
      "default": false, 
      "description": "Backend web servers typically log each request they handle along with the requesting client IP address. These logs are used for debugging, analytics and other such purposes. If the deployment topology requires enabling SNAT on the load balancer, then server will see the client as the SNAT IP which defeats the purpose of logging. To work around this issue, load balancer can be configured to insert XFF HTTP header with the original client IP address. Backend servers can then be configured to log the IP address in XFF header instead of the source IP address of the connection. If XFF header is not present in the incoming request, load balancer inserts a new XFF header with the client IP address.", 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "boolean"
    }, 
    "ip_address": {
      "$ref": "IPAddress, 
      "description": "Configures the IP address of the PolicyLbVirtualServer where it receives all client connections and distributes them among the backend servers.", 
      "required": true, 
      "title": "IP address of the PolicyLbVirtualServer"
    }, 
    "lb_persistence_profile": {
      "description": "Path to optional object that enables persistence on a virtual server allowing related client connections to be sent to the same backend server. Persistence is disabled by default.", 
      "required": false, 
      "title": "Persistence Profile used by PolicyLbVirtualServer", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "ports": {
      "description": "Ports contains a list of at least one port or port range such as \"80\", \"1234-1236\". Each port element in the list should be a single port or a single port range.", 
      "items": {
        "$ref": "PortElement
      }, 
      "required": true, 
      "title": "Virtual server port number(s) or port range(s)", 
      "type": "array"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "enum": [
        "TcpPolicyLbVirtualServer", 
        "UdpPolicyLbVirtualServer", 
        "HttpPolicyLbVirtualServer", 
        "HttpsPolicyLbVirtualServer", 
        "CustomPolicyLbVirtualServer"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "router_path": {
      "description": "Path to router type object that PolicyLbVirtualServer connects to. The only supported router object is Network.", 
      "required": true, 
      "title": "Path to router type object for PolicyLbVirtualServer", 
      "type": "string"
    }, 
    "server_auth_ca_certificate_ids": {
      "description": "To support client authentication (load balancer acting as a client authenticating to the backend server), server_ssl_certificate_id can be specified.  When supplied, the backend server certificate must be signed by one of the trusted Certificate Authorities (CAs), also referred to as root CAs, whose self signed certificates are specified. This setting is only applicable for L7 protocols and will be rejected in combination with TCP or UDP.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "ssl certificate", 
      "type": "array"
    }, 
    "server_ssl_settings": {
      "default": "DISABLED", 
      "description": "Indicates whether to enable server side SSL.  Server side SSL will be enabled when a specific security setting is selected. The selected security setting or profile represents various configurations related to SSL when the VirtualServer acts as a client connecting over SSL to the backend server.  This setting is only applicable for L7 protocols and will be rejected in combination with TCP or UDP. - BASE_SECURE_111317 - MODERATE_SECURE_111317 - HIGH_SECURE_111317 - DISABLED", 
      "enum": [
        "BASE_SECURE_111317", 
        "MODERATE_SECURE_111317", 
        "HIGH_SECURE_111317", 
        "DISABLED"
      ], 
      "required": false, 
      "title": "Security profile setting", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "traffic_source": {
      "type": "string"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "PolicyLbVirtualServer handling connections over HTTP or HTTPS", 
  "type": "object"
}

CustomWidgetConfiguration (type)

{
  "additionalProperties": false, 
  "description": "Represents configuration for custom widget. For this widget the data source is not applicable. It defines ui identifer to identify UI component and render it on dashboard view. This configuration can only be used for system owned widgets.", 
  "extends": {
    "$ref": "WidgetConfiguration
  }, 
  "id": "CustomWidgetConfiguration", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "polymorphic-type-descriptor": {
    "type-identifier": "CustomWidgetConfiguration"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "datasources": {
      "description": "The 'datasources' represent the sources from which data will be fetched. Currently, only NSX-API is supported as a 'default' datasource. An example of specifying 'default' datasource along with the urls to fetch data from is given at 'example_request' section of 'CreateWidgetConfiguration' API.", 
      "items": {
        "$ref": "Datasource
      }, 
      "minItems": 0, 
      "title": "Array of Datasource Instances with their relative urls", 
      "type": "array"
    }, 
    "default_filter_value": {
      "description": "Default filter values to be passed to datasources. This will be used when the report is requested without filter values.", 
      "items": {
        "$ref": "DefaultFilterValue
      }, 
      "title": "Default filter value to be passed to datasources", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "description": "Title of the widget. If display_name is omitted, the widget will be shown without a title.", 
      "maxLength": 255, 
      "title": "Widget Title", 
      "type": "string"
    }, 
    "drilldown_id": {
      "description": "Id of drilldown widget, if any. Id should be a valid id of an existing widget. A widget is considered as drilldown widget when it is associated with any other widget and provides more detailed information about any data item from the parent widget.", 
      "maxLength": 255, 
      "title": "Id of drilldown widget", 
      "type": "string"
    }, 
    "feature_set": {
      "$ref": "FeatureSet, 
      "description": "Features required to view the widget.", 
      "title": "Features required to view the widget"
    }, 
    "filter": {
      "description": "Id of filter widget for subscription, if any. Id should be a valid id of an existing filter widget. Filter widget should be from the same view. Datasource URLs should have placeholder values equal to filter alias to accept the filter value on filter change.", 
      "title": "Id of filter widget for subscription", 
      "type": "string"
    }, 
    "filter_value_required": {
      "default": true, 
      "description": "Flag to indicate that widget will continue to work without filter value. If this flag is set to false then default_filter_value is manadatory.", 
      "title": "Flag to indicate if filter value is necessary", 
      "type": "boolean"
    }, 
    "footer": {
      "$ref": "Footer
    }, 
    "icons": {
      "description": "Icons to be applied at dashboard for widgets and UI elements.", 
      "items": {
        "$ref": "Icon
      }, 
      "title": "Icons", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "is_drilldown": {
      "default": false, 
      "description": "Set to true if this widget should be used as a drilldown.", 
      "title": "Set as a drilldown widget", 
      "type": "boolean"
    }, 
    "legend": {
      "$ref": "Legend, 
      "description": "Legend to be displayed. If legend is not needed, do not include it.", 
      "title": "Legend for the widget"
    }, 
    "resource_type": {
      "description": "Supported visualization types are LabelValueConfiguration, DonutConfiguration, GridConfiguration, StatsConfiguration, MultiWidgetConfiguration, GraphConfiguration, ContainerConfiguration, CustomWidgetConfiguration and DropdownFilterWidgetConfiguration.", 
      "enum": [
        "LabelValueConfiguration", 
        "DonutConfiguration", 
        "MultiWidgetConfiguration", 
        "ContainerConfiguration", 
        "StatsConfiguration", 
        "GridConfiguration", 
        "GraphConfiguration", 
        "CustomWidgetConfiguration", 
        "DropdownFilterWidgetConfiguration"
      ], 
      "maxLength": 255, 
      "readonly": true, 
      "required": true, 
      "title": "Widget visualization type", 
      "type": "string"
    }, 
    "shared": {
      "deprecated": true, 
      "description": "Please use the property 'shared' of View instead of this. The widgets of a shared view are visible to other users.", 
      "title": "Visiblity of widgets to other users", 
      "type": "boolean"
    }, 
    "span": {
      "description": "Represents the horizontal span of the widget / container.", 
      "maximum": 12, 
      "minimum": 1, 
      "title": "Horizontal span", 
      "type": "int"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "ui_component_identifier": {
      "description": "User defined component selector to be rendered inside view/container.", 
      "title": "UI identifier for component to be rendered inside view/container", 
      "type": "string"
    }, 
    "weight": {
      "deprecated": true, 
      "description": "Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details.", 
      "title": "Weightage or placement of the widget or container", 
      "type": "int"
    }
  }, 
  "title": "Custom widget Configuration", 
  "type": "object"
}

CvxConnectionInfo (type)

{
  "additionalProperties": false, 
  "description": "Credential info to connect to a CVX type of enforcement point.", 
  "extends": {
    "$ref": "EnforcementPointConnectionInfo
  }, 
  "id": "CvxConnectionInfo", 
  "module_id": "PolicyEnforcementPointManagement", 
  "polymorphic-type-descriptor": {
    "type-identifier": "CvxConnectionInfo"
  }, 
  "properties": {
    "enforcement_point_address": {
      "description": "Value of this property could be Hostname or IP. For instance: - On an NSX-T MP running on default port, the value could be \"10.192.1.1\" - On an NSX-T MP running on custom port, the value could be \"192.168.1.1:32789\" - On an NSX-T MP in VMC deployments, the value could be \"192.168.1.1:5480/nsxapi\"", 
      "required": true, 
      "title": "Enforcement Point Address", 
      "type": "string"
    }, 
    "password": {
      "description": "Password.", 
      "required": true, 
      "sensitive": true, 
      "title": "Password", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "Resource Type of Enforcement Point Connection Info.", 
      "enum": [
        "NSXTConnectionInfo", 
        "NSXVConnectionInfo", 
        "CvxConnectionInfo"
      ], 
      "required": true, 
      "title": "Connection Info Resource Type", 
      "type": "string"
    }, 
    "thumbprint": {
      "description": "Thumbprint of EnforcementPoint in the form of a SHA-256 hash represented in lower case HEX.", 
      "required": false, 
      "title": "Thumbprint of Enforcement Point", 
      "type": "string"
    }, 
    "username": {
      "description": "Username.", 
      "required": true, 
      "sensitive": true, 
      "title": "Username", 
      "type": "string"
    }
  }, 
  "title": "CVX Connection Info", 
  "type": "object"
}

DADMode (type)

{
  "additionalProperties": false, 
  "description": "Duplicate address detection modes.", 
  "enum": [
    "LOOSE", 
    "STRICT"
  ], 
  "id": "DADMode", 
  "module_id": "Routing", 
  "title": "DAD Mode", 
  "type": "string"
}

DADStatus (type)

{
  "additionalProperties": false, 
  "description": "Duplicate address detection status for IP address on port.", 
  "enum": [
    "DUPLICATED", 
    "TENTATIVE", 
    "ASSIGNED", 
    "NOT_APPLICABLE", 
    "UNKNOWN"
  ], 
  "id": "DADStatus", 
  "module_id": "LogicalRouterPorts", 
  "title": "DAD Status", 
  "type": "string"
}

DNSForwarderStatisticsPerEnforcementPoint (type)

{
  "abstract": true, 
  "description": "DNS forwarder statistics per enforcement point.", 
  "id": "DNSForwarderStatisticsPerEnforcementPoint", 
  "module_id": "PolicyDNSStatistics", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "resource_type"
  }, 
  "properties": {
    "enforcement_point_path": {
      "description": "Policy path referencing the enforcement point from where the statistics are fetched.", 
      "readonly": true, 
      "title": "Enforcement point path", 
      "type": "string"
    }, 
    "resource_type": {
      "enum": [
        "NsxTDNSForwarderStatistics"
      ], 
      "required": true, 
      "type": "string"
    }
  }, 
  "title": "DNS forwarder statistics per enforcement point", 
  "type": "object"
}

DNSForwarderStatusPerEnforcementPoint (type)

{
  "abstract": true, 
  "description": "DNS forwarder status per enforcement point.", 
  "id": "DNSForwarderStatusPerEnforcementPoint", 
  "module_id": "PolicyDNSStatistics", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "resource_type"
  }, 
  "properties": {
    "enforcement_point_path": {
      "description": "Policy path referencing the enforcement point from where the status is fetched.", 
      "readonly": true, 
      "title": "Enforcement point path", 
      "type": "string"
    }, 
    "resource_type": {
      "enum": [
        "NsxTDNSForwarderStatus"
      ], 
      "required": true, 
      "type": "string"
    }
  }, 
  "title": "DNS forwarder status per enforcement point", 
  "type": "object"
}

DataCounter (type)

{
  "id": "DataCounter", 
  "module_id": "AggSvcL2Types", 
  "properties": {
    "dropped": {
      "required": false, 
      "title": "The dropped packets or bytes", 
      "type": "integer"
    }, 
    "multicast_broadcast": {
      "required": false, 
      "title": "The multicast and broadcast packets or bytes", 
      "type": "integer"
    }, 
    "total": {
      "required": true, 
      "title": "The total packets or bytes", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

DataSourceParameters (type)

{
  "id": "DataSourceParameters", 
  "module_id": "Types", 
  "properties": {
    "source": {
      "$ref": "DataSourceType, 
      "required": false, 
      "title": "The data source, either realtime or cached. If not provided, cached data is returned."
    }
  }, 
  "type": "object"
}

DataSourceType (type)

{
  "enum": [
    "realtime", 
    "cached"
  ], 
  "id": "DataSourceType", 
  "module_id": "Types", 
  "title": "Data source type.", 
  "type": "string"
}

Datasource (type)

{
  "additionalProperties": false, 
  "description": "An instance of a datasource configuration.", 
  "id": "Datasource", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "properties": {
    "display_name": {
      "description": "Name of a datasource instance.", 
      "maxLength": 255, 
      "required": true, 
      "title": "Datasource instance's display name", 
      "type": "string"
    }, 
    "urls": {
      "description": "Array of urls relative to the datasource configuration. For example, api/v1/fabric/nodes is a relative url of nsx-manager instance.", 
      "items": {
        "$ref": "UrlAlias
      }, 
      "required": true, 
      "title": "Array of relative urls and their aliases", 
      "type": "array"
    }
  }, 
  "title": "Datasource Instance", 
  "type": "object"
}

DatetimeUTC (type)

{
  "description": "Datetime string in UTC in the RFC3339 format 'yyyy-mm-ddThh:mm:ssZ'", 
  "id": "DatetimeUTC", 
  "title": "Datetime string in UTC", 
  "type": "string"
}

DefaultFilterValue (type)

{
  "additionalProperties": false, 
  "description": "An instance of a datasource configuration.", 
  "id": "DefaultFilterValue", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "properties": {
    "alias": {
      "description": "Filter alias.", 
      "required": true, 
      "title": "Filter alias", 
      "type": "string"
    }, 
    "value": {
      "description": "Filter default value.", 
      "required": true, 
      "title": "Filter default value", 
      "type": "string"
    }
  }, 
  "title": "Default filter values", 
  "type": "object"
}

DeleteRequestParameters (type)

{
  "additionalProperties": {}, 
  "id": "DeleteRequestParameters", 
  "module_id": "Common", 
  "properties": {
    "force": {
      "default": false, 
      "description": "If true, deleting the resource succeeds even if it is being referred as a resource reference.", 
      "title": "Force delete the resource even if it is being used somewhere\n", 
      "type": "boolean"
    }
  }, 
  "title": "Parameters that affect how delete operations are processed", 
  "type": "object"
}

DeploymentZone (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "Logical grouping of enforcement points. This is a deprecated type. DeploymentZone has been renamed to Site. Use Site.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "DeploymentZone", 
  "module_id": "PolicyEnforcementPointManagement", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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": "EnforcementPoint
      }, 
      "required": false, 
      "title": "Logical grouping of enforcement points", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Deployment zone", 
  "type": "object"
}

DetachClusterParameters (type)

{
  "id": "DetachClusterParameters", 
  "properties": {
    "force": {
      "enum": [
        "true", 
        "false"
      ], 
      "type": "string"
    }, 
    "graceful-shutdown": {
      "default": "false", 
      "enum": [
        "true", 
        "false"
      ], 
      "required": false, 
      "type": "string"
    }, 
    "ignore-repository-ip-check": {
      "default": "false", 
      "enum": [
        "true", 
        "false"
      ], 
      "required": false, 
      "type": "string"
    }
  }, 
  "type": "object"
}

DfwFirewallConfiguration (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "FirewallConfiguration
  }, 
  "id": "DfwFirewallConfiguration", 
  "module_id": "Policy", 
  "polymorphic-type-descriptor": {
    "type-identifier": "DfwFirewallConfiguration"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "disable_auto_drafts": {
      "default": false, 
      "description": "To disable auto drafts, set it to true. By default, auto drafts are enabled.", 
      "title": "Auto draft 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"
    }, 
    "enable_firewall": {
      "default": true, 
      "description": "If set to true, Firewall is enabled.", 
      "title": "Firewall enable flag", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "idfw_enabled": {
      "default": false, 
      "description": "If set to true, identity firewall is enabled.", 
      "title": "Identity firewall enable flag", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": [
        "DfwFirewallConfiguration"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "DFW Firewall related configurations", 
  "type": "object"
}

DhGroup (type)

{
  "additionalProperties": false, 
  "description": "Diffie-Hellman groups represent algorithm used to derive shared keys between IPSec VPN initiator and responder over an unsecured network. GROUP2 uses 1048-bit Modular Exponentiation (MODP) group. GROUP5 uses 1536-bit MODP group. GROUP14 uses 2048-bit MODP group. GROUP15 uses 3072-bit MODP group. GROUP16 uses 4096-bit MODP group. GROUP19 uses 256-bit Random Elliptic Curve (ECP) group. GROUP20 uses 384-bit Random ECP group. GROUP21 uses 521-bit Random ECP group.", 
  "enum": [
    "GROUP2", 
    "GROUP5", 
    "GROUP14", 
    "GROUP15", 
    "GROUP16", 
    "GROUP19", 
    "GROUP20", 
    "GROUP21"
  ], 
  "id": "DhGroup", 
  "module_id": "PolicyIPSecVpn", 
  "title": "Diffie-Hellman groups", 
  "type": "string"
}

DhcpHeader (type)

{
  "additionalProperties": false, 
  "id": "DhcpHeader", 
  "module_id": "Traceflow", 
  "properties": {
    "op_code": {
      "default": "BOOTREQUEST", 
      "description": "This is used to specify the general type of message. A client sending request to a server uses an op code of BOOTREQUEST, while a server replying uses an op code of BOOTREPLY.", 
      "enum": [
        "BOOTREQUEST", 
        "BOOTREPLY"
      ], 
      "required": false, 
      "title": "Message op code / message type", 
      "type": "string"
    }
  }, 
  "type": "object"
}

DhcpIpPoolUsage (type)

{
  "id": "DhcpIpPoolUsage", 
  "module_id": "AggSvcDhcp", 
  "properties": {
    "allocated_number": {
      "required": true, 
      "title": "allocated number. COULD BE INACCURATE, REFERENCE ONLY.", 
      "type": "integer"
    }, 
    "allocated_percentage": {
      "required": true, 
      "title": "allocated percentage. COULD BE INACCURATE, REFERENCE ONLY.", 
      "type": "integer"
    }, 
    "dhcp_ip_pool_id": {
      "required": true, 
      "title": "uuid of dhcp ip pool", 
      "type": "string"
    }, 
    "pool_size": {
      "required": true, 
      "title": "pool size", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

DhcpLeasePerIP (type)

{
  "id": "DhcpLeasePerIP", 
  "module_id": "AggSvcDhcp", 
  "properties": {
    "expire_time": {
      "required": false, 
      "title": "expire time of the lease", 
      "type": "string"
    }, 
    "ip_address": {
      "required": true, 
      "title": "ip address of client", 
      "type": "string"
    }, 
    "lease_time": {
      "required": false, 
      "title": "lease time of the ip address, in seconds", 
      "type": "string"
    }, 
    "mac_address": {
      "required": true, 
      "title": "mac address of client", 
      "type": "string"
    }, 
    "start_time": {
      "required": true, 
      "title": "start time of lease", 
      "type": "string"
    }, 
    "subnet": {
      "required": false, 
      "title": "subnet of client network", 
      "type": "string"
    }
  }, 
  "type": "object"
}

DhcpLeases (type)

{
  "id": "DhcpLeases", 
  "module_id": "AggSvcDhcp", 
  "properties": {
    "dhcp_server_id": {
      "required": false, 
      "title": "dhcp server uuid", 
      "type": "string"
    }, 
    "leases": {
      "items": {
        "$ref": "DhcpLeasePerIP
      }, 
      "maxItems": 65535, 
      "minItems": 0, 
      "required": false, 
      "title": "The lease info list of the server", 
      "type": "array"
    }, 
    "timestamp": {
      "$ref": "EpochMsTimestamp, 
      "required": false, 
      "title": "timestamp of the lease info"
    }
  }, 
  "type": "object"
}

DhcpLeasesResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "DhcpLeases
  }, 
  "id": "DhcpLeasesResult", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "connectivity_path": {
      "description": "Policy path to Segment, Tier0 or Tier1 gateway where DHCP server is attached.", 
      "required": false, 
      "title": "Policy path to Segment, Tier0 or Tier1 gateway", 
      "type": "string"
    }, 
    "dhcp_server_id": {
      "required": false, 
      "title": "dhcp server uuid", 
      "type": "string"
    }, 
    "leases": {
      "items": {
        "$ref": "DhcpLeasePerIP
      }, 
      "maxItems": 65535, 
      "minItems": 0, 
      "required": false, 
      "title": "The lease info list of the server", 
      "type": "array"
    }, 
    "timestamp": {
      "$ref": "EpochMsTimestamp, 
      "required": false, 
      "title": "timestamp of the lease info"
    }
  }, 
  "type": "object"
}

DhcpOption121 (type)

{
  "additionalProperties": false, 
  "description": "DHCP option 121 to define classless static route.", 
  "id": "DhcpOption121", 
  "module_id": "Dhcp", 
  "properties": {
    "static_routes": {
      "description": "Classless static route of DHCP option 121.", 
      "items": {
        "$ref": "ClasslessStaticRoute
      }, 
      "maxItems": 27, 
      "minItems": 1, 
      "required": true, 
      "title": "DHCP classless static routes", 
      "type": "array"
    }
  }, 
  "title": "DHCP option 121", 
  "type": "object"
}

DhcpRelayConfig (type)

{
  "additionalProperties": false, 
  "description": "DHCP relay configuration. Please note, the realized-state of this entity returned by the \"GET /policy/api/v1/infra/realized-state/realized-entity\" with this entity policy-path is irrelevant with the application status of this entity. Please do not rely on this returned realized-state to determine how this dhcp-relay-config was applied. The dhcp realization information was reflected in the realization states of the referencing Segment or T0/T1 gateway.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "DhcpRelayConfig", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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"
    }, 
    "server_addresses": {
      "description": "DHCP server IP addresses for DHCP relay configuration. Both IPv4 and IPv6 addresses are supported.", 
      "items": {
        "$ref": "IPAddress
      }, 
      "maxItems": 8, 
      "required": true, 
      "title": "DHCP relay addresses", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "DHCP relay configuration", 
  "type": "object"
}

DhcpRelayConfigListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "DhcpRelayConfigListResult", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "DhcpRelayConfig
      }, 
      "required": true, 
      "title": "DhcpRelayConfig results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged collection of DhcpRelayConfigs", 
  "type": "object"
}

DhcpServerConfig (type)

{
  "additionalProperties": false, 
  "description": "DHCP server configuration. Please note, the realized-state of this entity returned by the \"GET /policy/api/v1/infra/realized-state/realized-entity\" with this entity policy-path is irrelevant with the application status of this entity. Please do not rely on this returned realized-state to determine how this dhcp-server-config was applied. The dhcp realization information was reflected in the realization states of the referencing Segment or T0/T1 gateway.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "DhcpServerConfig", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "edge_cluster_path": {
      "description": "Edge cluster path. Auto assigned if only one edge cluster is configured on enforcement-point. Modifying edge cluster will reallocate DHCP server to the new edge cluster. Please note that re-allocating edge-cluster will result in losing of all exisitng DHCP lease information. Change edge cluster only when losing DHCP leases is not a real problem, e.g. cross-site migration or failover and all client hosts will be reboot and get new IP addresses.", 
      "required": false, 
      "title": "Edge cluster path", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "lease_time": {
      "default": 86400, 
      "description": "IP address lease time in seconds.", 
      "maximum": 4294967295, 
      "minimum": 60, 
      "required": false, 
      "title": "IP address lease time in seconds", 
      "type": "integer"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "preferred_edge_paths": {
      "description": "Policy paths to edge nodes on which the DHCP servers run. The first edge node is assigned as active edge, and second one as stanby edge. If only one edge node is specified, the DHCP servers will run without HA support. When this property is not specified, edge nodes are auto-assigned during realization of the DHCP server.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 2, 
      "required": false, 
      "title": "Edge node path", 
      "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"
    }, 
    "server_address": {
      "deprecated": true, 
      "description": "DHCP server address in CIDR format. Prefix length should be less than or equal to 30. DHCP server is deployed as DHCP relay service. This property is deprecated, use server_addresses instead. Both properties cannot be specified together with different new values.", 
      "format": "ip-cidr-block", 
      "required": false, 
      "title": "DHCP server address in CIDR format", 
      "type": "string"
    }, 
    "server_addresses": {
      "description": "DHCP server address in CIDR format. Both IPv4 and IPv6 address families are supported. Prefix length should be less than or equal to 30 for IPv4 address family and less than or equal to 126 for IPv6. When not specified, IPv4 value is auto-assigned to 100.96.0.1/30. Ignored when this object is configured at a Segment.", 
      "items": {
        "format": "ip-cidr-block", 
        "type": "string"
      }, 
      "maxItems": 2, 
      "required": false, 
      "title": "DHCP server address in CIDR format", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "DHCP server configuration", 
  "type": "object"
}

DhcpServerConfigListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "DhcpServerConfigListResult", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "DhcpServerConfig
      }, 
      "required": true, 
      "title": "DhcpServerConfig results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged collection of DhcpServerConfigs", 
  "type": "object"
}

DhcpServerLeaseRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "DhcpServerRequestParameters
  }, 
  "id": "DhcpServerLeaseRequestParameters", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "address": {
      "description": "IP address, IP range or MAC address to retrieve specific lease information. Either a \"address\" or a \"segment_path\" can be provided, but not both in the same call.", 
      "required": false, 
      "title": "IP or MAC address", 
      "type": "string"
    }, 
    "connectivity_path": {
      "description": "String Path of Tier0, Tier1 or Segment where DHCP server is deployed. Specify Tier0/Tier1 gateway path for DHCP server attached to the gateway. Segment path must be specified for local DHCP server configuration.", 
      "required": true, 
      "title": "String Path of Tier0, Tier1 or Segment", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "enforcement_point_path": {
      "description": "Enforcement point path. Required when multiple enforcement points are configured.", 
      "required": false, 
      "title": "String Path of the enforcement point", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "segment_path": {
      "description": "Segment path to retrieve lease information. Either a \"address\" or a \"segment_path\" can be provided, but not both in the same call.", 
      "required": false, 
      "title": "Segment path to retrieve lease information", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "source": {
      "$ref": "DataSourceType, 
      "description": "The data source, either realtime or cached. If not provided, cached data is returned.", 
      "required": false, 
      "title": "The data source"
    }
  }, 
  "title": "DHCP server lease request parameters", 
  "type": "object"
}

DhcpServerRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "DhcpServerRequestParameters", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "connectivity_path": {
      "description": "String Path of Tier0, Tier1 or Segment where DHCP server is deployed. Specify Tier0/Tier1 gateway path for DHCP server attached to the gateway. Segment path must be specified for local DHCP server configuration.", 
      "required": true, 
      "title": "String Path of Tier0, Tier1 or Segment", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "enforcement_point_path": {
      "description": "Enforcement point path. Required when multiple enforcement points are configured.", 
      "required": false, 
      "title": "String Path of the enforcement point", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "DHCP server list request parameters", 
  "type": "object"
}

DhcpServerState (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ConfigurationState
  }, 
  "id": "DhcpServerState", 
  "module_id": "PolicyConnectivityStatistics", 
  "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. Additional enums with more details on progress/success/error states are sent for edge node. The success states are NODE_READY and TRANSPORT_NODE_READY, pending states are {VM_DEPLOYMENT_QUEUED, VM_DEPLOYMENT_IN_PROGRESS, REGISTRATION_PENDING} and other values indicate failures. \"in_sync\" state indicates that the desired configuration has been received by the host to which it applies, but is not yet in effect. When the configuration is actually in effect, the state will change to \"success\". Please note, failed state is deprecated.", 
      "enum": [
        "pending", 
        "in_progress", 
        "success", 
        "failed", 
        "partial_success", 
        "orphaned", 
        "unknown", 
        "error", 
        "in_sync", 
        "NOT_AVAILABLE", 
        "VM_DEPLOYMENT_QUEUED", 
        "VM_DEPLOYMENT_IN_PROGRESS", 
        "VM_DEPLOYMENT_FAILED", 
        "VM_POWER_ON_IN_PROGRESS", 
        "VM_POWER_ON_FAILED", 
        "REGISTRATION_PENDING", 
        "NODE_NOT_READY", 
        "NODE_READY", 
        "VM_POWER_OFF_IN_PROGRESS", 
        "VM_POWER_OFF_FAILED", 
        "VM_UNDEPLOY_IN_PROGRESS", 
        "VM_UNDEPLOY_FAILED", 
        "VM_UNDEPLOY_SUCCESSFUL", 
        "EDGE_CONFIG_ERROR", 
        "VM_DEPLOYMENT_RESTARTED", 
        "REGISTRATION_FAILED", 
        "TRANSPORT_NODE_SYNC_PENDING", 
        "TRANSPORT_NODE_CONFIGURATION_MISSING", 
        "EDGE_HARDWARE_NOT_SUPPORTED", 
        "MULTIPLE_OVERLAY_TZS_NOT_SUPPORTED", 
        "TN_OVERLAY_TZ_IN_USE_BY_EDGE_CLUSTER", 
        "TZ_ENDPOINTS_NOT_SPECIFIED", 
        "NO_PNIC_PREPARED_IN_EDGE", 
        "APPLIANCE_INTERNAL_ERROR", 
        "VTEP_DHCP_NOT_SUPPORTED", 
        "UNSUPPORTED_HOST_SWITCH_PROFILE", 
        "UPLINK_HOST_SWITCH_PROFILE_NOT_SPECIFIED", 
        "HOSTSWITCH_PROFILE_NOT_FOUND", 
        "LLDP_SEND_ENABLED_NOT_SUPPORTED", 
        "UNSUPPORTED_NAMED_TEAMING_POLICY", 
        "LBSRCID_NOT_SUPPORTED_FOR_EDGE_VM", 
        "LACP_NOT_SUPPORTED_FOR_EDGE_VM", 
        "STANDBY_UPLINKS_NOT_SUPPORTED_FOR_EDGE_VM", 
        "MULTIPLE_ACTIVE_UPLINKS_NOT_SUPPORTED_FOR_EDGE", 
        "UNSUPPORTED_LACP_LB_ALGO_FOR_NODE", 
        "EDGE_NODE_VERSION_NOT_SUPPORTED", 
        "NO_PNIC_SPECIFIED_IN_TN", 
        "INVALID_PNIC_DEVICE_NAME", 
        "TRANSPORT_NODE_READY", 
        "VM_NETWORK_EDIT_PENDING", 
        "UNSUPPORTED_DEFAULT_TEAMING_POLICY", 
        "MPA_DISCONNECTED", 
        "VM_RENAME_PENDING", 
        "VM_CONFIG_EDIT_PENDING", 
        "VM_NETWORK_EDIT_FAILED", 
        "VM_RENAME_FAILED", 
        "VM_CONFIG_EDIT_FAILED", 
        "VM_CONFIG_DISCREPANCY", 
        "VM_NODE_REFRESH_FAILED", 
        "VM_PLACEMENT_REFRESH_FAILED", 
        "REGISTRATION_TIMEDOUT", 
        "REPLACE_FAILED", 
        "UPLINK_FROM_TEAMING_POLICY_NOT_MAPPED", 
        "LOGICAL_SWITCH_NAMED_TEAMING_HAS_NO_PNIC_BACKING", 
        "DELETE_VM_IN_REDEPLOY_FAILED", 
        "DEPLOY_VM_IN_REDEPLOY_FAILED", 
        "INSUFFICIENT_RESOURCES_IN_EDGE_NODE_FOR_SERVICE"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Overall state of desired configuration", 
      "type": "string"
    }
  }, 
  "type": "object"
}

DhcpServerStatistics (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "DhcpStatistics
  }, 
  "id": "DhcpServerStatistics", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "acks": {
      "required": true, 
      "title": "The total number of DHCP ACK packets", 
      "type": "integer"
    }, 
    "declines": {
      "required": true, 
      "title": "The total number of DHCP DECLINE packets", 
      "type": "integer"
    }, 
    "dhcp_server_id": {
      "required": true, 
      "title": "dhcp server uuid", 
      "type": "string"
    }, 
    "discovers": {
      "required": true, 
      "title": "The total number of DHCP DISCOVER packets", 
      "type": "integer"
    }, 
    "errors": {
      "required": true, 
      "title": "The total number of DHCP errors", 
      "type": "integer"
    }, 
    "informs": {
      "required": true, 
      "title": "The total number of DHCP INFORM packets", 
      "type": "integer"
    }, 
    "ip_pool_stats": {
      "items": {
        "$ref": "DhcpIpPoolUsage
      }, 
      "required": false, 
      "title": "The DHCP ip pool usage statistics", 
      "type": "array"
    }, 
    "nacks": {
      "required": true, 
      "title": "The total number of DHCP NACK packets", 
      "type": "integer"
    }, 
    "offers": {
      "required": true, 
      "title": "The total number of DHCP OFFER packets", 
      "type": "integer"
    }, 
    "releases": {
      "required": true, 
      "title": "The total number of DHCP RELEASE packets", 
      "type": "integer"
    }, 
    "requests": {
      "required": true, 
      "title": "The total number of DHCP REQUEST packets", 
      "type": "integer"
    }, 
    "timestamp": {
      "$ref": "EpochMsTimestamp, 
      "required": true, 
      "title": "timestamp of the statistics"
    }
  }, 
  "type": "object"
}

DhcpServerStatus (type)

{
  "id": "DhcpServerStatus", 
  "module_id": "AggSvcDhcp", 
  "properties": {
    "active_node": {
      "required": true, 
      "title": "uuid of active transport node", 
      "type": "string"
    }, 
    "error_message": {
      "required": false, 
      "title": "Error message, if available", 
      "type": "string"
    }, 
    "service_status": {
      "description": "UP means the dhcp service is working fine on both active transport-node and stand-by transport-node (if have), hence fail-over can work at this time if there is failure happens on one of the transport-node; DOWN means the dhcp service is down on both active transport-node and stand-by node (if have), hence the dhcp-service will not repsonse any dhcp request; Error means error happens on transport-node(s) or no status is reported from transport-node(s). The dhcp service may be working (or not working); NO_STANDBY means dhcp service is working in one of the transport node while not in the other transport-node (if have). Hence if the dhcp service in the working transport-node is down, fail-over will not happen and the dhcp service will go down.", 
      "enum": [
        "UP", 
        "DOWN", 
        "ERROR", 
        "NO_STANDBY"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "stand_by_node": {
      "required": false, 
      "title": "uuid of stand_by transport node. null if non-HA mode", 
      "type": "string"
    }
  }, 
  "type": "object"
}

DhcpStaticBindingConfig (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "description": "DHCP IPv4 and IPv6 static bindings are extended from this abstract class.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "DhcpStaticBindingConfig", 
  "module_id": "PolicyConnectivity", 
  "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: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": [
        "DhcpV4StaticBindingConfig", 
        "DhcpV6StaticBindingConfig"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Base class for DHCP options", 
  "type": "object"
}

DhcpStaticBindingConfigListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "DhcpStaticBindingConfigListResult", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "DhcpStaticBindingConfig
      }, 
      "required": true, 
      "title": "Paginated list of DhcpStaticBindingConfig", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

DhcpStaticBindingState (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ConfigurationState
  }, 
  "id": "DhcpStaticBindingState", 
  "module_id": "PolicyConnectivityStatistics", 
  "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. Additional enums with more details on progress/success/error states are sent for edge node. The success states are NODE_READY and TRANSPORT_NODE_READY, pending states are {VM_DEPLOYMENT_QUEUED, VM_DEPLOYMENT_IN_PROGRESS, REGISTRATION_PENDING} and other values indicate failures. \"in_sync\" state indicates that the desired configuration has been received by the host to which it applies, but is not yet in effect. When the configuration is actually in effect, the state will change to \"success\". Please note, failed state is deprecated.", 
      "enum": [
        "pending", 
        "in_progress", 
        "success", 
        "failed", 
        "partial_success", 
        "orphaned", 
        "unknown", 
        "error", 
        "in_sync", 
        "NOT_AVAILABLE", 
        "VM_DEPLOYMENT_QUEUED", 
        "VM_DEPLOYMENT_IN_PROGRESS", 
        "VM_DEPLOYMENT_FAILED", 
        "VM_POWER_ON_IN_PROGRESS", 
        "VM_POWER_ON_FAILED", 
        "REGISTRATION_PENDING", 
        "NODE_NOT_READY", 
        "NODE_READY", 
        "VM_POWER_OFF_IN_PROGRESS", 
        "VM_POWER_OFF_FAILED", 
        "VM_UNDEPLOY_IN_PROGRESS", 
        "VM_UNDEPLOY_FAILED", 
        "VM_UNDEPLOY_SUCCESSFUL", 
        "EDGE_CONFIG_ERROR", 
        "VM_DEPLOYMENT_RESTARTED", 
        "REGISTRATION_FAILED", 
        "TRANSPORT_NODE_SYNC_PENDING", 
        "TRANSPORT_NODE_CONFIGURATION_MISSING", 
        "EDGE_HARDWARE_NOT_SUPPORTED", 
        "MULTIPLE_OVERLAY_TZS_NOT_SUPPORTED", 
        "TN_OVERLAY_TZ_IN_USE_BY_EDGE_CLUSTER", 
        "TZ_ENDPOINTS_NOT_SPECIFIED", 
        "NO_PNIC_PREPARED_IN_EDGE", 
        "APPLIANCE_INTERNAL_ERROR", 
        "VTEP_DHCP_NOT_SUPPORTED", 
        "UNSUPPORTED_HOST_SWITCH_PROFILE", 
        "UPLINK_HOST_SWITCH_PROFILE_NOT_SPECIFIED", 
        "HOSTSWITCH_PROFILE_NOT_FOUND", 
        "LLDP_SEND_ENABLED_NOT_SUPPORTED", 
        "UNSUPPORTED_NAMED_TEAMING_POLICY", 
        "LBSRCID_NOT_SUPPORTED_FOR_EDGE_VM", 
        "LACP_NOT_SUPPORTED_FOR_EDGE_VM", 
        "STANDBY_UPLINKS_NOT_SUPPORTED_FOR_EDGE_VM", 
        "MULTIPLE_ACTIVE_UPLINKS_NOT_SUPPORTED_FOR_EDGE", 
        "UNSUPPORTED_LACP_LB_ALGO_FOR_NODE", 
        "EDGE_NODE_VERSION_NOT_SUPPORTED", 
        "NO_PNIC_SPECIFIED_IN_TN", 
        "INVALID_PNIC_DEVICE_NAME", 
        "TRANSPORT_NODE_READY", 
        "VM_NETWORK_EDIT_PENDING", 
        "UNSUPPORTED_DEFAULT_TEAMING_POLICY", 
        "MPA_DISCONNECTED", 
        "VM_RENAME_PENDING", 
        "VM_CONFIG_EDIT_PENDING", 
        "VM_NETWORK_EDIT_FAILED", 
        "VM_RENAME_FAILED", 
        "VM_CONFIG_EDIT_FAILED", 
        "VM_CONFIG_DISCREPANCY", 
        "VM_NODE_REFRESH_FAILED", 
        "VM_PLACEMENT_REFRESH_FAILED", 
        "REGISTRATION_TIMEDOUT", 
        "REPLACE_FAILED", 
        "UPLINK_FROM_TEAMING_POLICY_NOT_MAPPED", 
        "LOGICAL_SWITCH_NAMED_TEAMING_HAS_NO_PNIC_BACKING", 
        "DELETE_VM_IN_REDEPLOY_FAILED", 
        "DEPLOY_VM_IN_REDEPLOY_FAILED", 
        "INSUFFICIENT_RESOURCES_IN_EDGE_NODE_FOR_SERVICE"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Overall state of desired configuration", 
      "type": "string"
    }
  }, 
  "type": "object"
}

DhcpStatistics (type)

{
  "id": "DhcpStatistics", 
  "module_id": "AggSvcDhcp", 
  "properties": {
    "acks": {
      "required": true, 
      "title": "The total number of DHCP ACK packets", 
      "type": "integer"
    }, 
    "declines": {
      "required": true, 
      "title": "The total number of DHCP DECLINE packets", 
      "type": "integer"
    }, 
    "dhcp_server_id": {
      "required": true, 
      "title": "dhcp server uuid", 
      "type": "string"
    }, 
    "discovers": {
      "required": true, 
      "title": "The total number of DHCP DISCOVER packets", 
      "type": "integer"
    }, 
    "errors": {
      "required": true, 
      "title": "The total number of DHCP errors", 
      "type": "integer"
    }, 
    "informs": {
      "required": true, 
      "title": "The total number of DHCP INFORM packets", 
      "type": "integer"
    }, 
    "ip_pool_stats": {
      "items": {
        "$ref": "DhcpIpPoolUsage
      }, 
      "required": false, 
      "title": "The DHCP ip pool usage statistics", 
      "type": "array"
    }, 
    "nacks": {
      "required": true, 
      "title": "The total number of DHCP NACK packets", 
      "type": "integer"
    }, 
    "offers": {
      "required": true, 
      "title": "The total number of DHCP OFFER packets", 
      "type": "integer"
    }, 
    "releases": {
      "required": true, 
      "title": "The total number of DHCP RELEASE packets", 
      "type": "integer"
    }, 
    "requests": {
      "required": true, 
      "title": "The total number of DHCP REQUEST packets", 
      "type": "integer"
    }, 
    "timestamp": {
      "$ref": "EpochMsTimestamp, 
      "required": true, 
      "title": "timestamp of the statistics"
    }
  }, 
  "type": "object"
}

DhcpV4Options (type)

{
  "additionalProperties": false, 
  "description": "DHCP options for IPv4 server.", 
  "id": "DhcpV4Options", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "option121": {
      "$ref": "DhcpOption121, 
      "description": "DHCP option 121 to define classless static routes.", 
      "required": false, 
      "title": "DHCP option 121"
    }, 
    "others": {
      "description": "To define DHCP options other than option 121 in generic format. Please note, only the following options can be defined in generic format. Those other options will be accepted without validation but will not take effect. --------------------------   Code    Name --------------------------     2   Time Offset     6   Domain Name Server     13  Boot File Size     19  Forward On/Off     26  MTU Interface     28  Broadcast Address     35  ARP Timeout     40  NIS Domain     41  NIS Servers     42  NTP Servers     44  NETBIOS Name Srv     45  NETBIOS Dist Srv     46  NETBIOS Node Type     47  NETBIOS Scope     58  Renewal Time     59  Rebinding Time     64  NIS+-Domain-Name     65  NIS+-Server-Addr     66  TFTP Server-Name (used by PXE)     67  Bootfile-Name (used by PXE)     93  PXE: Client system architecture     94  PXE: Client NDI     97  PXE: UUID/UNDI     117 Name Service Search     119 Domain Search     150 TFTP server address (used by PXE)     175 Etherboot     209 PXE Configuration File     210 PXE Path Prefix     211 PXE Reboot Time", 
      "items": {
        "$ref": "GenericDhcpOption
      }, 
      "maxItems": 255, 
      "minItems": 0, 
      "required": false, 
      "title": "Other DHCP options", 
      "type": "array"
    }
  }, 
  "title": "DHCP options for IPv4 address family", 
  "type": "object"
}

DhcpV4StaticBindingConfig (type)

{
  "additionalProperties": false, 
  "description": "DHCP IPv4 static bindings are configured for each segment.", 
  "extends": {
    "$ref": "DhcpStaticBindingConfig
  }, 
  "id": "DhcpV4StaticBindingConfig", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "DhcpV4StaticBindingConfig"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "gateway_address": {
      "$ref": "IPv4Address, 
      "description": "When not specified, gateway address is auto-assigned from segment configuration.", 
      "title": "Gateway IP address"
    }, 
    "host_name": {
      "description": "Hostname to assign to the host.", 
      "maxLength": 63, 
      "title": "Host name", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ip_address": {
      "$ref": "IPv4Address, 
      "description": "IP assigned to host. The IP address must belong to the subnet, if any, configured on Segment.", 
      "required": true, 
      "title": "IP assigned to host"
    }, 
    "lease_time": {
      "default": 86400, 
      "description": "DHCP lease time in seconds.", 
      "maximum": 4294967295, 
      "minimum": 60, 
      "title": "Lease time", 
      "type": "integer"
    }, 
    "mac_address": {
      "$ref": "MACAddress, 
      "description": "MAC address of the host.", 
      "required": true, 
      "title": "MAC address of host"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "options": {
      "$ref": "DhcpV4Options, 
      "description": "IPv4 DHCP options.", 
      "required": false, 
      "title": "DHCP options"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": [
        "DhcpV4StaticBindingConfig", 
        "DhcpV6StaticBindingConfig"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "DHCP static binding", 
  "type": "object"
}

DhcpV6StaticBindingConfig (type)

{
  "additionalProperties": false, 
  "description": "DHCP IPv6 static bindings are configured for each segment.", 
  "extends": {
    "$ref": "DhcpStaticBindingConfig
  }, 
  "id": "DhcpV6StaticBindingConfig", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "DhcpV6StaticBindingConfig"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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"
    }, 
    "dns_nameservers": {
      "description": "When not specified, no DNS nameserver will be set to client host.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 2, 
      "minItems": 0, 
      "required": false, 
      "title": "DNS nameservers to be set to client host", 
      "type": "array"
    }, 
    "domain_names": {
      "description": "When not specified, no domain name will be assigned to client host.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Domain names to be assigned to client host", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ip_addresses": {
      "description": "When not specified, no ip address will be assigned to client host.", 
      "items": {
        "$ref": "IPv6Address
      }, 
      "maxItems": 1, 
      "minItems": 0, 
      "required": false, 
      "title": "IP addresses to be assigned to client host", 
      "type": "array"
    }, 
    "lease_time": {
      "default": 86400, 
      "description": "Lease time, in seconds.", 
      "maximum": 4294967295, 
      "minimum": 60, 
      "required": false, 
      "title": "Lease time", 
      "type": "integer"
    }, 
    "mac_address": {
      "$ref": "MACAddress, 
      "description": "The MAC address of the client host. Either client-duid or mac-address, but not both.", 
      "required": true, 
      "title": "MAC address"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "preferred_time": {
      "description": "Preferred time, in seconds. If this value is not provided, the value of lease_time*0.8 will be used.", 
      "maximum": 4294967295, 
      "minimum": 48, 
      "required": false, 
      "title": "Preferred time", 
      "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": [
        "DhcpV4StaticBindingConfig", 
        "DhcpV6StaticBindingConfig"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "sntp_servers": {
      "description": "SNTP server IP addresses.", 
      "items": {
        "$ref": "IPv6Address
      }, 
      "maxItems": 2, 
      "minItems": 0, 
      "required": false, 
      "title": "SNTP server ips", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "DHCP static binding", 
  "type": "object"
}

Dhcpv6Header (type)

{
  "additionalProperties": false, 
  "id": "Dhcpv6Header", 
  "module_id": "Traceflow", 
  "properties": {
    "msg_type": {
      "default": "SOLICIT", 
      "description": "This is used to specify the DHCP v6 message. To request the assignment of one or more IPv6 addresses, a client first locates a DHCP server and then requests the assignment of addresses and other configuration information from the server. The client sends a Solicit message to the All_DHCP_Relay_Agents_and_Servers address to find available DHCP servers. Any server that can meet the client's requirements responds with an Advertise message. The client then chooses one of the servers and sends a Request message to the server asking for confirmed assignment of addresses and other configuration information. The server responds with a Reply message that contains the confirmed addresses and configuration. SOLICIT - A client sends a Solicit message to locate servers. ADVERTISE - A server sends and Advertise message to indicate that it is available. REQUEST - A client sends a Request message to request configuration parameters. REPLY - A server sends a Reply message containing assigned addresses and configuration parameters.", 
      "enum": [
        "SOLICIT", 
        "ADVERTISE", 
        "REQUEST", 
        "REPLY"
      ], 
      "required": false, 
      "title": "DHCP message type", 
      "type": "string"
    }
  }, 
  "type": "object"
}

DiscoveredNode (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "DiscoveredResource
  }, 
  "id": "DiscoveredNode", 
  "module_id": "InventoryCmObj", 
  "properties": {
    "_last_sync_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "certificate": {
      "required": false, 
      "title": "Certificate of the discovered node", 
      "type": "string"
    }, 
    "cm_local_id": {
      "readonly": true, 
      "required": true, 
      "title": "Local Id of the discovered node in the Compute Manager", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "external_id": {
      "readonly": true, 
      "required": true, 
      "title": "External id of the discovered node, ex. a mo-ref from VC", 
      "type": "string"
    }, 
    "hardware_id": {
      "description": "Hardware Id is generated using system hardware info. It is used to retrieve fabric node of the esx.", 
      "readonly": true, 
      "required": false, 
      "title": "Hardware Id of the discovered node", 
      "type": "string"
    }, 
    "ip_addresses": {
      "items": {
        "$ref": "IPAddress
      }, 
      "readonly": true, 
      "required": true, 
      "title": "IP Addresses of the the discovered node.", 
      "type": "array"
    }, 
    "node_type": {
      "readonly": true, 
      "required": true, 
      "title": "Discovered Node type like Host", 
      "type": "string"
    }, 
    "origin_id": {
      "readonly": true, 
      "required": true, 
      "title": "Id of the compute manager from where this node was discovered", 
      "type": "string"
    }, 
    "origin_properties": {
      "items": {
        "$ref": "KeyValuePair
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Key-Value map of additional specific properties of discovered\nnode in the Compute Manager\n", 
      "type": "array"
    }, 
    "os_type": {
      "readonly": true, 
      "required": false, 
      "title": "OS type of the discovered node", 
      "type": "string"
    }, 
    "os_version": {
      "readonly": true, 
      "required": false, 
      "title": "OS version of the discovered node", 
      "type": "string"
    }, 
    "parent_compute_collection": {
      "readonly": true, 
      "required": false, 
      "title": "External id of the compute collection to which this node belongs", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }, 
    "stateless": {
      "description": "The stateless property describes whether host persists its state across reboot or not. If state persists, value is set as false otherwise true.", 
      "readonly": true, 
      "required": false, 
      "title": "Specifies whether host is stateless", 
      "type": "boolean"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

DiscoveredResource (type)

{
  "abstract": true, 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "DiscoveredResource", 
  "module_id": "Common", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "resource_type"
  }, 
  "properties": {
    "_last_sync_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Base class for resources that are discovered and automatically updated", 
  "type": "object"
}

DiscoveryProfileBindingMap (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "DiscoveryProfileBindingMap", 
  "module_id": "PolicyDiscoveryProfileBinding", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Base Discovery Profile Binding Map", 
  "type": "object"
}

DistributedFloodProtectionProfile (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "FloodProtectionProfile
  }, 
  "id": "DistributedFloodProtectionProfile", 
  "module_id": "PolicyProfile", 
  "polymorphic-type-descriptor": {
    "type-identifier": "DistributedFloodProtectionProfile"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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"
    }, 
    "enable_rst_spoofing": {
      "default": false, 
      "description": "If set to true, rst spoofing will be enabled. Flag is used only for distributed firewall profiles.", 
      "readonly": false, 
      "title": "Flag to indicate rst spoofing is enabled", 
      "type": "boolean"
    }, 
    "enable_syncache": {
      "default": false, 
      "description": "If set to true, sync cache will be enabled. Flag is used only for distributed firewall profiles.", 
      "readonly": false, 
      "title": "Flag to indicate syncache is enabled", 
      "type": "boolean"
    }, 
    "icmp_active_flow_limit": {
      "description": "If this field is empty, firewall will not set a limit to active ICMP connections.", 
      "maximum": 1000000, 
      "minimum": 1, 
      "title": "Active ICMP connections limit", 
      "type": "integer"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "other_active_conn_limit": {
      "description": "If this field is empty, firewall will not set a limit to other active connections. besides UDP, ICMP and half open TCP connections.", 
      "maximum": 1000000, 
      "minimum": 1, 
      "title": "Timeout after first TN", 
      "type": "integer"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": {
      "$ref": "FloodProtectionProfileResourceType, 
      "required": true
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "tcp_half_open_conn_limit": {
      "description": "If this field is empty, firewall will not set a limit to half open TCP connections.", 
      "maximum": 1000000, 
      "minimum": 1, 
      "title": "Active half open TCP connections limit", 
      "type": "integer"
    }, 
    "udp_active_flow_limit": {
      "description": "If this field is empty, firewall will not set a limit to active UDP connections.", 
      "maximum": 1000000, 
      "minimum": 1, 
      "title": "Active UDP connections limit", 
      "type": "integer"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "type": "object"
}

DistributedVirtualPortgroup (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "VirtualPortgroup
  }, 
  "id": "DistributedVirtualPortgroup", 
  "module_id": "InventoryCmObj", 
  "polymorphic-type-descriptor": {
    "type-identifier": "DistributedVirtualPortgroup"
  }, 
  "properties": {
    "_last_sync_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "backing_type": {
      "description": "For distributed virtual portgroup, backing type is standard. For logical switch portgroup, the backing type is set to nsx.", 
      "readonly": false, 
      "title": "Backing type for portgroup", 
      "type": "string"
    }, 
    "cm_local_id": {
      "description": "Id of the portgroup, eg. a mo-ref from VC.", 
      "readonly": true, 
      "required": false, 
      "title": "Id of the portgroup in compute manager", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "external_id": {
      "readonly": true, 
      "required": true, 
      "title": "External id of the virtual portgroup", 
      "type": "string"
    }, 
    "key": {
      "readonly": false, 
      "title": "Generated UUID of the portgroup", 
      "type": "string"
    }, 
    "origin_type": {
      "readonly": true, 
      "required": false, 
      "title": "Portgroup type like DistributedVirtualPortgroup", 
      "type": "string"
    }, 
    "overall_status": {
      "description": "This parameters reflects the managed entity status of the portgroup as reported by VC.", 
      "enum": [
        "RED", 
        "YELLOW", 
        "GREEN", 
        "GRAY"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "General status of the virtual portgroup", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Distributed virtual portgroup on a VC", 
  "type": "object"
}

DistributedVirtualSwitch (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "VirtualSwitch
  }, 
  "id": "DistributedVirtualSwitch", 
  "module_id": "InventoryCmObj", 
  "polymorphic-type-descriptor": {
    "type-identifier": "DistributedVirtualSwitch"
  }, 
  "properties": {
    "_last_sync_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cm_local_id": {
      "readonly": true, 
      "required": false, 
      "title": "ID of the virtual switch in compute manager", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "discovered_nodes": {
      "description": "Array of discovered nodes connected to this switch.", 
      "items": {
        "$ref": "DiscoveredNode
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Array of discovered nodes connected", 
      "type": "array"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "external_id": {
      "readonly": true, 
      "required": true, 
      "title": "External id of the virtual switch", 
      "type": "string"
    }, 
    "lacp_group_configs": {
      "description": "It contains information about VMware specific multiple dynamic LACP groups.", 
      "items": {
        "$ref": "LacpGroupConfigInfo
      }, 
      "readonly": false, 
      "required": false, 
      "title": "Array of Link Aggregation Control Protocol (LACP) configuration", 
      "type": "array"
    }, 
    "origin_id": {
      "description": "ID of the compute manager where this virtual switch is discovered.", 
      "readonly": true, 
      "required": false, 
      "title": "ID of the compute manager", 
      "type": "string"
    }, 
    "origin_properties": {
      "items": {
        "$ref": "KeyValuePair
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Key-Value map of additional properties of switch", 
      "type": "array"
    }, 
    "origin_type": {
      "readonly": true, 
      "required": false, 
      "title": "Switch type like VmwareDistributedVirtualSwitch", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "uplink_port_names": {
      "description": "The uniform name of uplink ports on each host.", 
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Uplink port names", 
      "type": "array"
    }, 
    "uplink_portgroup": {
      "$ref": "DistributedVirtualPortgroup, 
      "readonly": true, 
      "required": false, 
      "title": "Uplink portgroup of distributed virtual switch"
    }, 
    "uuid": {
      "readonly": true, 
      "required": false, 
      "title": "UUID of the switch", 
      "type": "string"
    }
  }, 
  "title": "DistributedVirtualSwitch on a VC", 
  "type": "object"
}

DnsHeader (type)

{
  "additionalProperties": false, 
  "id": "DnsHeader", 
  "module_id": "Traceflow", 
  "properties": {
    "address": {
      "description": "This is used to define what is being asked or responded.", 
      "format": "hostname-or-ip", 
      "required": false, 
      "title": "Domain name/IP to query/response", 
      "type": "string"
    }, 
    "address_type": {
      "default": "V4", 
      "description": "This is used to specify the type of the address. V4 - The address provided is an IPv4 domain name/IP address, the Type in query or response will be A V6 - The address provided is an IPv6 domain name/IP address, the Type in query or response will be AAAA", 
      "enum": [
        "V4", 
        "V6"
      ], 
      "required": false, 
      "title": null, 
      "type": "string"
    }, 
    "message_type": {
      "default": "QUERY", 
      "enum": [
        "QUERY", 
        "RESPONSE"
      ], 
      "required": false, 
      "title": "Specifies the message type whether it is a query or a response.", 
      "type": "string"
    }
  }, 
  "type": "object"
}

DnsSecurityProfile (type)

{
  "additionalProperties": false, 
  "description": "Used to configure DNS security profile", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "DnsSecurityProfile", 
  "module_id": "PolicyProfile", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "ttl": {
      "default": 86400, 
      "description": "Time to live for DNS cache entry in seconds. Valid TTL values are between 3600 to 864000. However, this field accepts values between 0 through 864000. We define TTL type based on the value of TTL as follows: TTL 0 - cached entry never expires. TTL 1 to 3599 - invalid input and error is thrown TTL 3600 to 864000 - ttl is set to user input TTL field not set by user - TTL type is 'AUTO' and ttl value is set from DNS response packet.  User defined TTL value is used only when it is betweeen 3600 to 864000.", 
      "maximum": 864000, 
      "minimum": 0, 
      "required": false, 
      "title": "Time to live for DNS cache entry", 
      "type": "integer"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "DNS security profile", 
  "type": "object"
}

DnsSecurityProfileBindingMap (type)

{
  "additionalProperties": false, 
  "description": "This entity will be used to establish association between DNS security profile and Group. With this entity, user can specify intent for applying DNS security profile profile to particular Group.", 
  "extends": {
    "$ref": "ProfileBindingMap
  }, 
  "id": "DnsSecurityProfileBindingMap", 
  "module_id": "PolicyFirewallDnsSecurityProfileBinding", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "profile_path": {
      "description": "PolicyPath of associated Profile", 
      "required": true, 
      "title": "Profile Path", 
      "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": "Sequence number used to resolve conflicts betweeen two profiles applied on the same group. Lower sequence number takes higher precedence. Two binding maps applied to the same profile must have the same sequence number. User defined sequence numbers range from 1 through 100,000. System defined sequence numbers range from 100,001 through 200,000.", 
      "maximum": 100000, 
      "minimum": 1, 
      "requried": true, 
      "title": "Sequence number DNS Security Profile Binding Map", 
      "type": "integer"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Binding Map for DNS Security Profile", 
  "type": "object"
}

DnsSecurityProfileBindingMapListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "DnsSecurityProfileBindingMapListRequestParameters", 
  "module_id": "PolicyFirewallDnsSecurityProfileBinding", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "DNS Security Profile Binding Map List Request Parameters", 
  "type": "object"
}

DnsSecurityProfileBindingMapListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "DnsSecurityProfileBindingMapListResult", 
  "module_id": "PolicyFirewallDnsSecurityProfileBinding", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "DnsSecurityProfileBindingMap
      }, 
      "requried": true, 
      "title": "DNS Security Profile Binding Map List Results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged collection of DNS Security Profile Binding Map", 
  "type": "object"
}

DnsSecurityProfileListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "DnsSecurityProfileListResult", 
  "module_id": "PolicyProfile", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "DnsSecurityProfile
      }, 
      "required": true, 
      "title": "DnsSecurityProfile list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of DnsSecurityProfile", 
  "type": "object"
}

Domain (type)

{
  "additionalProperties": false, 
  "description": "Domain.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "Domain", 
  "module_id": "Policy", 
  "policy_hierarchical_children": [
    "ChildDomainDeploymentMap", 
    "ChildForwardingPolicy", 
    "ChildGatewayPolicy", 
    "ChildGroup", 
    "ChildSecurityPolicy"
  ], 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Domain", 
  "type": "object"
}

DomainDeploymentMap (type)

{
  "additionalProperties": false, 
  "description": "Binding of domain to the enforcement point.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "DomainDeploymentMap", 
  "module_id": "PolicyEnforcementPointManagement", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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_point_path": {
      "description": "Path of enforcement point on which domain shall be enforced.", 
      "required": true, 
      "title": "Absolute path of enforcement point", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Domain Deployment Map", 
  "type": "object"
}

DomainDeploymentMapListRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "Domain Deployment Map list request parameters.", 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "DomainDeploymentMapListRequestParameters", 
  "module_id": "PolicyEnforcementPointManagement", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Domain Deployment Map List Request Parameters", 
  "type": "object"
}

DomainDeploymentMapListResult (type)

{
  "additionalProperties": false, 
  "description": "Paged collection of Domain Deployment Map.", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "DomainDeploymentMapListResult", 
  "module_id": "PolicyEnforcementPointManagement", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Domain Deployment Map list result.", 
      "items": {
        "$ref": "DomainDeploymentMap
      }, 
      "required": true, 
      "title": "Domain Deployment Map List Result", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of Domain Deployment Map", 
  "type": "object"
}

DomainListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "DomainListRequestParameters", 
  "module_id": "Policy", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Domain list request parameters", 
  "type": "object"
}

DomainListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "DomainListResult", 
  "module_id": "Policy", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "Domain
      }, 
      "required": true, 
      "title": "Domain list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of Domains", 
  "type": "object"
}

DonutConfiguration (type)

{
  "additionalProperties": false, 
  "description": "Represents configuration of a Donut", 
  "extends": {
    "$ref": "WidgetConfiguration
  }, 
  "id": "DonutConfiguration", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "polymorphic-type-descriptor": {
    "type-identifier": "DonutConfiguration"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "count": {
      "description": "Expression to retrieve count to be shown on Donut.", 
      "title": "Expression to retrieve count to be shown on Donut", 
      "type": "string"
    }, 
    "datasources": {
      "description": "The 'datasources' represent the sources from which data will be fetched. Currently, only NSX-API is supported as a 'default' datasource. An example of specifying 'default' datasource along with the urls to fetch data from is given at 'example_request' section of 'CreateWidgetConfiguration' API.", 
      "items": {
        "$ref": "Datasource
      }, 
      "minItems": 0, 
      "title": "Array of Datasource Instances with their relative urls", 
      "type": "array"
    }, 
    "default_filter_value": {
      "description": "Default filter values to be passed to datasources. This will be used when the report is requested without filter values.", 
      "items": {
        "$ref": "DefaultFilterValue
      }, 
      "title": "Default filter value to be passed to datasources", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_count": {
      "default": true, 
      "description": "If true, displays the count of entities in the donut", 
      "title": "Show or hide the count of entities", 
      "type": "boolean"
    }, 
    "display_name": {
      "description": "Title of the widget. If display_name is omitted, the widget will be shown without a title.", 
      "maxLength": 255, 
      "title": "Widget Title", 
      "type": "string"
    }, 
    "drilldown_id": {
      "description": "Id of drilldown widget, if any. Id should be a valid id of an existing widget. A widget is considered as drilldown widget when it is associated with any other widget and provides more detailed information about any data item from the parent widget.", 
      "maxLength": 255, 
      "title": "Id of drilldown widget", 
      "type": "string"
    }, 
    "feature_set": {
      "$ref": "FeatureSet, 
      "description": "Features required to view the widget.", 
      "title": "Features required to view the widget"
    }, 
    "filter": {
      "description": "Id of filter widget for subscription, if any. Id should be a valid id of an existing filter widget. Filter widget should be from the same view. Datasource URLs should have placeholder values equal to filter alias to accept the filter value on filter change.", 
      "title": "Id of filter widget for subscription", 
      "type": "string"
    }, 
    "filter_value_required": {
      "default": true, 
      "description": "Flag to indicate that widget will continue to work without filter value. If this flag is set to false then default_filter_value is manadatory.", 
      "title": "Flag to indicate if filter value is necessary", 
      "type": "boolean"
    }, 
    "footer": {
      "$ref": "Footer
    }, 
    "icons": {
      "description": "Icons to be applied at dashboard for widgets and UI elements.", 
      "items": {
        "$ref": "Icon
      }, 
      "title": "Icons", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "is_drilldown": {
      "default": false, 
      "description": "Set to true if this widget should be used as a drilldown.", 
      "title": "Set as a drilldown widget", 
      "type": "boolean"
    }, 
    "label": {
      "$ref": "Label, 
      "description": "Displayed at the middle of the donut, by default. It labels the entities of donut.", 
      "title": "Label of the Donut Configuration"
    }, 
    "legend": {
      "$ref": "Legend, 
      "description": "Legend to be displayed. If legend is not needed, do not include it.", 
      "title": "Legend for the widget"
    }, 
    "navigation": {
      "description": "Hyperlink of the specified UI page that provides details.", 
      "maxLength": 1024, 
      "title": "Navigation to a specified UI page", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "Supported visualization types are LabelValueConfiguration, DonutConfiguration, GridConfiguration, StatsConfiguration, MultiWidgetConfiguration, GraphConfiguration, ContainerConfiguration, CustomWidgetConfiguration and DropdownFilterWidgetConfiguration.", 
      "enum": [
        "LabelValueConfiguration", 
        "DonutConfiguration", 
        "MultiWidgetConfiguration", 
        "ContainerConfiguration", 
        "StatsConfiguration", 
        "GridConfiguration", 
        "GraphConfiguration", 
        "CustomWidgetConfiguration", 
        "DropdownFilterWidgetConfiguration"
      ], 
      "maxLength": 255, 
      "readonly": true, 
      "required": true, 
      "title": "Widget visualization type", 
      "type": "string"
    }, 
    "sections": {
      "decription": "High level logical grouping of portions or segments of donut.", 
      "items": {
        "$ref": "DonutSection
      }, 
      "minItems": 1, 
      "required": true, 
      "title": "Sections", 
      "type": "array"
    }, 
    "shared": {
      "deprecated": true, 
      "description": "Please use the property 'shared' of View instead of this. The widgets of a shared view are visible to other users.", 
      "title": "Visiblity of widgets to other users", 
      "type": "boolean"
    }, 
    "span": {
      "description": "Represents the horizontal span of the widget / container.", 
      "maximum": 12, 
      "minimum": 1, 
      "title": "Horizontal span", 
      "type": "int"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "weight": {
      "deprecated": true, 
      "description": "Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details.", 
      "title": "Weightage or placement of the widget or container", 
      "type": "int"
    }
  }, 
  "title": "Donut Configuration", 
  "type": "object"
}

DonutPart (type)

{
  "additionalProperties": false, 
  "description": "Represents an entity or portion to be plotted on a donut or stats chart.", 
  "id": "DonutPart", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "properties": {
    "condition": {
      "description": "If the condition is met then the part will be displayed. Examples of expression syntax are provided under 'example_request' section of 'CreateWidgetConfiguration' API.", 
      "title": "Expression for evaluating condition", 
      "type": "string"
    }, 
    "drilldown_id": {
      "description": "Id of drilldown widget, if any. Id should be a valid id of an existing widget. A widget is considered as drilldown widget when it is associated with any other widget and provides more detailed information about any data item from the parent widget.", 
      "title": "Id of drilldown widget", 
      "type": "string"
    }, 
    "field": {
      "description": "A numerical value that represents the portion or entity of the donut or stats chart.", 
      "maxLength": 1024, 
      "required": true, 
      "title": "Value of the portion or entity of donut or stats chart", 
      "type": "string"
    }, 
    "hide_empty_legend": {
      "default": false, 
      "description": "If true, legend will be shown only if the data for the part is available. This is applicable only if legends are specified in widget configuration.", 
      "title": "Hide the legend if the data for the part is not available", 
      "type": "boolean"
    }, 
    "label": {
      "$ref": "Label, 
      "description": "If a section 'template' holds this donut or stats part, then the label is auto-generated from the fetched field values after applying the template.", 
      "title": "Label of the portion or entity of donut or stats chart"
    }, 
    "navigation": {
      "description": "Hyperlink of the specified UI page that provides details. If drilldown_id is provided, then navigation cannot be used.", 
      "title": "Navigation to a specified UI page", 
      "type": "string"
    }, 
    "render_configuration": {
      "description": "Additional rendering or conditional evaluation of the field values to be performed, if any.", 
      "items": {
        "$ref": "RenderConfiguration
      }, 
      "minItems": 0, 
      "title": "Render Configuration", 
      "type": "array"
    }, 
    "tooltip": {
      "description": "Multi-line text to be shown on tooltip while hovering over the portion.", 
      "items": {
        "$ref": "Tooltip
      }, 
      "minItems": 0, 
      "title": "Multi-line tooltip", 
      "type": "array"
    }
  }, 
  "title": "Portion of a donut or stats chart", 
  "type": "object"
}

DonutSection (type)

{
  "additionalProperties": false, 
  "description": "Represents high level logical grouping of portions or segments of a donut / stats chart.", 
  "id": "DonutSection", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "properties": {
    "parts": {
      "description": "Array of portions or parts of the donut or stats chart.", 
      "items": {
        "$ref": "DonutPart
      }, 
      "minItems": 1, 
      "required": true, 
      "title": "Parts of a donut / stats chart", 
      "type": "array"
    }, 
    "row_list_field": {
      "description": "Field of the root of the api result set for forming parts.", 
      "maxLength": 1024, 
      "title": "Field from which parts of the donut or stats chart are formed", 
      "type": "string"
    }, 
    "template": {
      "default": false, 
      "description": "If true, the section will be appled as template for forming parts. Only one part will be formed from each element of 'row_list_field'.", 
      "title": "Template, if any, for automatically forming the donut or stats parts", 
      "type": "boolean"
    }
  }, 
  "title": "Section of a donut or stats chart", 
  "type": "object"
}

DropdownFilterWidgetConfiguration (type)

{
  "additionalProperties": false, 
  "description": "Represents configuration for dropdown filter widget.", 
  "extends": {
    "$ref": "FilterWidgetConfiguration
  }, 
  "id": "DropdownFilterWidgetConfiguration", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "polymorphic-type-descriptor": {
    "type-identifier": "DropdownFilterWidgetConfiguration"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "alias": {
      "description": "Alias to be used when emitting filter value.", 
      "title": "Alias to be used when emitting filter value", 
      "type": "string"
    }, 
    "datasources": {
      "description": "The 'datasources' represent the sources from which data will be fetched. Currently, only NSX-API is supported as a 'default' datasource. An example of specifying 'default' datasource along with the urls to fetch data from is given at 'example_request' section of 'CreateWidgetConfiguration' API.", 
      "items": {
        "$ref": "Datasource
      }, 
      "minItems": 0, 
      "title": "Array of Datasource Instances with their relative urls", 
      "type": "array"
    }, 
    "default_filter_value": {
      "description": "Default filter values to be passed to datasources. This will be used when the report is requested without filter values.", 
      "items": {
        "$ref": "DefaultFilterValue
      }, 
      "title": "Default filter value to be passed to datasources", 
      "type": "array"
    }, 
    "default_value": {
      "description": "Expression to specify default value of filter.", 
      "title": "Expression to specify default value", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "description": "Title of the widget. If display_name is omitted, the widget will be shown without a title.", 
      "maxLength": 255, 
      "title": "Widget Title", 
      "type": "string"
    }, 
    "drilldown_id": {
      "description": "Id of drilldown widget, if any. Id should be a valid id of an existing widget. A widget is considered as drilldown widget when it is associated with any other widget and provides more detailed information about any data item from the parent widget.", 
      "maxLength": 255, 
      "title": "Id of drilldown widget", 
      "type": "string"
    }, 
    "dropdown_item": {
      "$ref": "DropdownItem, 
      "description": "Defines the item of a dropdown.", 
      "required": true, 
      "title": "Definition for item of a dropdown"
    }, 
    "feature_set": {
      "$ref": "FeatureSet, 
      "description": "Features required to view the widget.", 
      "title": "Features required to view the widget"
    }, 
    "filter": {
      "description": "Id of filter widget for subscription, if any. Id should be a valid id of an existing filter widget. Filter widget should be from the same view. Datasource URLs should have placeholder values equal to filter alias to accept the filter value on filter change.", 
      "title": "Id of filter widget for subscription", 
      "type": "string"
    }, 
    "filter_value_required": {
      "default": true, 
      "description": "Flag to indicate that widget will continue to work without filter value. If this flag is set to false then default_filter_value is manadatory.", 
      "title": "Flag to indicate if filter value is necessary", 
      "type": "boolean"
    }, 
    "footer": {
      "$ref": "Footer
    }, 
    "icons": {
      "description": "Icons to be applied at dashboard for widgets and UI elements.", 
      "items": {
        "$ref": "Icon
      }, 
      "title": "Icons", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "is_drilldown": {
      "default": false, 
      "description": "Set to true if this widget should be used as a drilldown.", 
      "title": "Set as a drilldown widget", 
      "type": "boolean"
    }, 
    "legend": {
      "$ref": "Legend, 
      "description": "Legend to be displayed. If legend is not needed, do not include it.", 
      "title": "Legend for the widget"
    }, 
    "placeholder_msg": {
      "description": "Placeholder message to be displayed in dropdown filter.", 
      "title": "Placeholder message to be shown in filter", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "Supported visualization types are LabelValueConfiguration, DonutConfiguration, GridConfiguration, StatsConfiguration, MultiWidgetConfiguration, GraphConfiguration, ContainerConfiguration, CustomWidgetConfiguration and DropdownFilterWidgetConfiguration.", 
      "enum": [
        "LabelValueConfiguration", 
        "DonutConfiguration", 
        "MultiWidgetConfiguration", 
        "ContainerConfiguration", 
        "StatsConfiguration", 
        "GridConfiguration", 
        "GraphConfiguration", 
        "CustomWidgetConfiguration", 
        "DropdownFilterWidgetConfiguration"
      ], 
      "maxLength": 255, 
      "readonly": true, 
      "required": true, 
      "title": "Widget visualization type", 
      "type": "string"
    }, 
    "shared": {
      "deprecated": true, 
      "description": "Please use the property 'shared' of View instead of this. The widgets of a shared view are visible to other users.", 
      "title": "Visiblity of widgets to other users", 
      "type": "boolean"
    }, 
    "span": {
      "description": "Represents the horizontal span of the widget / container.", 
      "maximum": 12, 
      "minimum": 1, 
      "title": "Horizontal span", 
      "type": "int"
    }, 
    "static_filter_condition": {
      "description": "If the condition is met then the static filter will be added. If no condition is provided, then the static filters will be applied unconditionally.", 
      "title": "Expression for evaluating condition", 
      "type": "string"
    }, 
    "static_filters": {
      "description": "Additional static items to be added in dropdown filter. Example can be 'ALL'.", 
      "items": {
        "$ref": "StaticFilter
      }, 
      "title": "Additional static items to be added in dropdown filter", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "weight": {
      "deprecated": true, 
      "description": "Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details.", 
      "title": "Weightage or placement of the widget or container", 
      "type": "int"
    }
  }, 
  "title": "Dropdown Filter widget Configuration", 
  "type": "object"
}

DropdownItem (type)

{
  "additionalProperties": false, 
  "id": "DropdownItem", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "properties": {
    "display_name": {
      "description": "expression to extract display name to be shown in the drop down.", 
      "maxLength": 1024, 
      "title": "Display name for item to be displayed in dropdown", 
      "type": "string"
    }, 
    "field": {
      "description": "An expression that represents the items of the dropdown filter.", 
      "required": true, 
      "title": "Expression for dropdown items of filter", 
      "type": "string"
    }, 
    "value": {
      "description": "Value of filter inside dropdown filter.", 
      "required": true, 
      "title": "Value for item to be displayed in dropdown", 
      "type": "string"
    }
  }, 
  "title": "Dropdown item definition", 
  "type": "object"
}

DscpTrustMode (type)

{
  "default": "TRUSTED", 
  "description": "When you select the Trusted mode the inner header DSCP value is applied to the outer IP header for IP/IPv6 traffic. For non IP/IPv6 traffic, the outer IP header takes the default value.Untrusted mode is supported on overlay-based and VLAN-based logical port.", 
  "enum": [
    "TRUSTED", 
    "UNTRUSTED"
  ], 
  "id": "DscpTrustMode", 
  "module_id": "PolicyQoS", 
  "title": "Trust settings", 
  "type": "string"
}

DuplicateAddressBindingEntry (type)

{
  "extends": {
    "$ref": "AddressBindingEntry
  }, 
  "id": "DuplicateAddressBindingEntry", 
  "module_id": "LogicalPort", 
  "properties": {
    "binding": {
      "$ref": "PacketAddressClassifier, 
      "title": "Combination of IP-MAC-VLAN binding"
    }, 
    "binding_timestamp": {
      "$ref": "EpochMsTimestamp, 
      "description": "Timestamp at which the binding was discovered via snooping or manually specified by the user", 
      "title": "Timestamp of binding"
    }, 
    "conflicting_port": {
      "description": "Provides the ID of the port on which the same address bidning exists", 
      "required": false, 
      "title": "ID of logical port with the same address binding", 
      "type": "string"
    }, 
    "source": {
      "$ref": "AddressBindingSource, 
      "default": "UNKNOWN", 
      "description": "Source from which the address binding entry was obtained", 
      "title": "Address binding source"
    }
  }, 
  "title": "Duplicate address binding information", 
  "type": "object"
}

DuplicateIPDetectionOptions (type)

{
  "additionalProperties": false, 
  "description": "Contains dupliacte IP detection related discovery options.", 
  "id": "DuplicateIPDetectionOptions", 
  "module_id": "PolicyIpDiscovery", 
  "properties": {
    "duplicate_ip_detection_enabled": {
      "default": false, 
      "description": "Indicates whether duplicate IP detection should be enabled", 
      "required": false, 
      "title": "Duplicate IP detection", 
      "type": "boolean"
    }
  }, 
  "title": "Controls duplicate IP detection options", 
  "type": "object"
}

EPActionForDnsForwarderRequestParameters (type)

{
  "id": "EPActionForDnsForwarderRequestParameters", 
  "module_id": "PolicyDnsForwarder", 
  "properties": {
    "action": {
      "description": "The valid DNS forwarder actions to be performed on EP are, - clear_cache:       Clear the current cache of the dns forwarder from       specified enforcement point.", 
      "enum": [
        "clear_cache"
      ], 
      "required": true, 
      "title": "An action to be performed for DNS forwarder on EP", 
      "type": "string"
    }, 
    "enforcement_point_path": {
      "default": "/infra/sites/default/enforcement-points/default", 
      "description": "An enforcement point path, on which the action is to be performed. If not specified, default enforcement point path, /infra/sites/default/enforcement-points/default will be considered.", 
      "required": false, 
      "title": "An enforcement point path, on which the action is to be performed", 
      "type": "string"
    }
  }, 
  "type": "object"
}

EULAAcceptance (type)

{
  "additionalProperties": false, 
  "description": "Indicate the status of End User License Agreement acceptance", 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "EULAAcceptance", 
  "module_id": "EULA", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "acceptance": {
      "description": "Acceptance status of End User License Agreement", 
      "required": true, 
      "title": "End User License Agreement acceptance status", 
      "type": "boolean"
    }
  }, 
  "title": "EULA acceptance status", 
  "type": "object"
}

EULAContent (type)

{
  "additionalProperties": false, 
  "description": "End User License Agreement content", 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "EULAContent", 
  "module_id": "EULA", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "content": {
      "description": "Content of End User License Agreement", 
      "required": true, 
      "sensitive": true, 
      "title": "End User License Agreement content", 
      "type": "string"
    }
  }, 
  "title": "EULA content", 
  "type": "object"
}

EULAOutputFormatRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "Indicate output format of End User License Agreement content", 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "EULAOutputFormatRequestParameters", 
  "module_id": "EULA", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "value_format": {
      "title": "End User License Agreement content output format", 
      "type": "string"
    }
  }, 
  "type": "object"
}

EdgeConfigurationState (type)

{
  "additionalProperties": false, 
  "description": "This contains fields that captures state of Trackable entities. Edge and VPN state entities extend this object.", 
  "extends": {
    "$ref": "ConfigurationState
  }, 
  "id": "EdgeConfigurationState", 
  "module_id": "LogicalRouter", 
  "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"
    }, 
    "pending_change_list": {
      "description": "Request identifier of the API which modified the entity.", 
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "required": false, 
      "title": "List of pending changes", 
      "type": "array"
    }, 
    "state": {
      "description": "Gives details of state of desired configuration. Additional enums with more details on progress/success/error states are sent for edge node. The success states are NODE_READY and TRANSPORT_NODE_READY, pending states are {VM_DEPLOYMENT_QUEUED, VM_DEPLOYMENT_IN_PROGRESS, REGISTRATION_PENDING} and other values indicate failures. \"in_sync\" state indicates that the desired configuration has been received by the host to which it applies, but is not yet in effect. When the configuration is actually in effect, the state will change to \"success\". Please note, failed state is deprecated.", 
      "enum": [
        "pending", 
        "in_progress", 
        "success", 
        "failed", 
        "partial_success", 
        "orphaned", 
        "unknown", 
        "error", 
        "in_sync", 
        "NOT_AVAILABLE", 
        "VM_DEPLOYMENT_QUEUED", 
        "VM_DEPLOYMENT_IN_PROGRESS", 
        "VM_DEPLOYMENT_FAILED", 
        "VM_POWER_ON_IN_PROGRESS", 
        "VM_POWER_ON_FAILED", 
        "REGISTRATION_PENDING", 
        "NODE_NOT_READY", 
        "NODE_READY", 
        "VM_POWER_OFF_IN_PROGRESS", 
        "VM_POWER_OFF_FAILED", 
        "VM_UNDEPLOY_IN_PROGRESS", 
        "VM_UNDEPLOY_FAILED", 
        "VM_UNDEPLOY_SUCCESSFUL", 
        "EDGE_CONFIG_ERROR", 
        "VM_DEPLOYMENT_RESTARTED", 
        "REGISTRATION_FAILED", 
        "TRANSPORT_NODE_SYNC_PENDING", 
        "TRANSPORT_NODE_CONFIGURATION_MISSING", 
        "EDGE_HARDWARE_NOT_SUPPORTED", 
        "MULTIPLE_OVERLAY_TZS_NOT_SUPPORTED", 
        "TN_OVERLAY_TZ_IN_USE_BY_EDGE_CLUSTER", 
        "TZ_ENDPOINTS_NOT_SPECIFIED", 
        "NO_PNIC_PREPARED_IN_EDGE", 
        "APPLIANCE_INTERNAL_ERROR", 
        "VTEP_DHCP_NOT_SUPPORTED", 
        "UNSUPPORTED_HOST_SWITCH_PROFILE", 
        "UPLINK_HOST_SWITCH_PROFILE_NOT_SPECIFIED", 
        "HOSTSWITCH_PROFILE_NOT_FOUND", 
        "LLDP_SEND_ENABLED_NOT_SUPPORTED", 
        "UNSUPPORTED_NAMED_TEAMING_POLICY", 
        "LBSRCID_NOT_SUPPORTED_FOR_EDGE_VM", 
        "LACP_NOT_SUPPORTED_FOR_EDGE_VM", 
        "STANDBY_UPLINKS_NOT_SUPPORTED_FOR_EDGE_VM", 
        "MULTIPLE_ACTIVE_UPLINKS_NOT_SUPPORTED_FOR_EDGE", 
        "UNSUPPORTED_LACP_LB_ALGO_FOR_NODE", 
        "EDGE_NODE_VERSION_NOT_SUPPORTED", 
        "NO_PNIC_SPECIFIED_IN_TN", 
        "INVALID_PNIC_DEVICE_NAME", 
        "TRANSPORT_NODE_READY", 
        "VM_NETWORK_EDIT_PENDING", 
        "UNSUPPORTED_DEFAULT_TEAMING_POLICY", 
        "MPA_DISCONNECTED", 
        "VM_RENAME_PENDING", 
        "VM_CONFIG_EDIT_PENDING", 
        "VM_NETWORK_EDIT_FAILED", 
        "VM_RENAME_FAILED", 
        "VM_CONFIG_EDIT_FAILED", 
        "VM_CONFIG_DISCREPANCY", 
        "VM_NODE_REFRESH_FAILED", 
        "VM_PLACEMENT_REFRESH_FAILED", 
        "REGISTRATION_TIMEDOUT", 
        "REPLACE_FAILED", 
        "UPLINK_FROM_TEAMING_POLICY_NOT_MAPPED", 
        "LOGICAL_SWITCH_NAMED_TEAMING_HAS_NO_PNIC_BACKING", 
        "DELETE_VM_IN_REDEPLOY_FAILED", 
        "DEPLOY_VM_IN_REDEPLOY_FAILED", 
        "INSUFFICIENT_RESOURCES_IN_EDGE_NODE_FOR_SERVICE"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Overall state of desired configuration", 
      "type": "string"
    }
  }, 
  "title": "Configuration State for Edge and VPN entities.", 
  "type": "object"
}

EdgeTransportNodeDatapathMemoryPoolUsage (type)

{
  "additionalProperties": false, 
  "description": "Datapath memory pool usage value.", 
  "id": "EdgeTransportNodeDatapathMemoryPoolUsage", 
  "module_id": "ApplianceStats", 
  "properties": {
    "description": {
      "description": "Description of the memory pool.", 
      "readonly": true, 
      "title": "Description of the memory pool", 
      "type": "string"
    }, 
    "name": {
      "description": "Name of the datapath memory pool as available on edge node CLI.", 
      "readonly": true, 
      "title": "Name of the datapath memory pool", 
      "type": "string"
    }, 
    "usage": {
      "description": "Percentage of memory pool in use.", 
      "readonly": true, 
      "title": "Percentage of memory pool in use", 
      "type": "number"
    }
  }, 
  "title": "Usage of datapath memory pool", 
  "type": "object"
}

EdgeTransportNodeDatapathMemoryUsage (type)

{
  "additionalProperties": false, 
  "description": "Detailed view of the datapath memory usage. Details out the heap and per memory pool point in time usage.", 
  "id": "EdgeTransportNodeDatapathMemoryUsage", 
  "module_id": "ApplianceStats", 
  "properties": {
    "datapath_heap_usage": {
      "description": "Percentage of heap memory in use.", 
      "readonly": true, 
      "title": "Percentage of heap memory in use", 
      "type": "number"
    }, 
    "datapath_mem_pools_usage": {
      "items": {
        "$ref": "EdgeTransportNodeDatapathMemoryPoolUsage, 
        "description": "Per memory pool percentage in use.", 
        "readonly": true, 
        "title": "Per memory pool percentage in use"
      }, 
      "type": "array"
    }, 
    "highest_datapath_mem_pool_usage": {
      "description": "Highest percentage usage value among datapath memory pools.", 
      "readonly": true, 
      "title": "Highest percentage usage value among datapath memory pools", 
      "type": "number"
    }, 
    "highest_datapath_mem_pool_usage_names": {
      "items": {
        "description": "List of datapath memory pool(s) with highest usage.", 
        "readonly": true, 
        "title": "Datapath memory pool(s) with highest usage", 
        "type": "string"
      }, 
      "type": "array"
    }
  }, 
  "title": "Detailed view of the datapath memory usage. Details out the heap and per memory pool usage", 
  "type": "object"
}

EdgeTransportNodeMemoryUsage (type)

{
  "additionalProperties": false, 
  "description": "Point in time usage of system, datapath, swap and cache memory in edge node.", 
  "id": "EdgeTransportNodeMemoryUsage", 
  "module_id": "ApplianceStats", 
  "properties": {
    "cache_usage": {
      "description": "Percentage of RAM on the system that can be flushed out to disk.", 
      "readonly": true, 
      "title": "Percentage of RAM on the system that can be flushed out to disk", 
      "type": "number"
    }, 
    "datapath_mem_usage_details": {
      "$ref": "EdgeTransportNodeDatapathMemoryUsage, 
      "description": "Detailed view of the datapath memory usage. Details out the heap and per memory pool point in time usage.", 
      "readonly": true, 
      "title": "Detailed view of the datapath memory usage. Details out the heap and per memory pool usage"
    }, 
    "datapath_total_usage": {
      "description": "Percentage of memory in use by datapath processes which includes RES and hugepage memory.", 
      "readonly": true, 
      "title": "Percentage of memory in use by datapath processes", 
      "type": "number"
    }, 
    "swap_usage": {
      "description": "Percentage of swap disk in use.", 
      "readonly": true, 
      "title": "Percentage of swap disk in use", 
      "type": "number"
    }, 
    "system_mem_usage": {
      "description": "Percentage of RAM in use on edge node.", 
      "readonly": true, 
      "title": "Percentage of RAM in use on edge node", 
      "type": "number"
    }
  }, 
  "title": "Memory usage details of edge node", 
  "type": "object"
}

EdgeUpgradeStatus (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ComponentUpgradeStatus
  }, 
  "id": "EdgeUpgradeStatus", 
  "module_id": "Upgrade", 
  "properties": {
    "can_skip": {
      "readonly": true, 
      "required": false, 
      "title": "Can the upgrade of the remaining units in this component be skipped", 
      "type": "boolean"
    }, 
    "component_type": {
      "readonly": true, 
      "required": false, 
      "title": "Component type for the upgrade status", 
      "type": "string"
    }, 
    "current_version_node_summary": {
      "$ref": "NodeSummaryList, 
      "readonly": true, 
      "required": false, 
      "title": "Mapping of current versions of nodes and counts of nodes at the respective versions."
    }, 
    "details": {
      "readonly": true, 
      "required": false, 
      "title": "Details about the upgrade status", 
      "type": "string"
    }, 
    "node_count_at_target_version": {
      "description": "Number of nodes of the type and at the component version", 
      "readonly": true, 
      "required": false, 
      "title": "Count of nodes at target component version", 
      "type": "int"
    }, 
    "percent_complete": {
      "readonly": true, 
      "required": true, 
      "title": "Indicator of upgrade progress in percentage", 
      "type": "number"
    }, 
    "pre_upgrade_status": {
      "$ref": "UpgradeChecksExecutionStatus, 
      "readonly": true, 
      "required": false, 
      "title": "Pre-upgrade status of the component-type"
    }, 
    "status": {
      "enum": [
        "SUCCESS", 
        "FAILED", 
        "IN_PROGRESS", 
        "NOT_STARTED", 
        "PAUSING", 
        "PAUSED"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Upgrade status of component", 
      "type": "string"
    }, 
    "target_component_version": {
      "readonly": true, 
      "required": false, 
      "title": "Target component version", 
      "type": "string"
    }
  }, 
  "title": "Status of edge upgrade", 
  "type": "object"
}

EffectiveIPInfo (type)

{
  "additionalProperties": false, 
  "id": "EffectiveIPInfo", 
  "module_id": "GroupingObjectsProviders", 
  "properties": {
    "effective_ips": {
      "items": {
        "$ref": "IPElement
      }, 
      "required": true, 
      "type": "array"
    }, 
    "site_id": {
      "required": true, 
      "title": "Id of the site to which the effective IPs belong to\n", 
      "type": "string"
    }
  }, 
  "title": "List of effective ip address along with site id", 
  "type": "object"
}

EgressRateLimiter (type)

{
  "extends": {
    "$ref": "QoSBaseRateLimiter
  }, 
  "id": "EgressRateLimiter", 
  "module_id": "PolicyQoS", 
  "polymorphic-type-descriptor": {
    "type-identifier": "EgressRateLimiter"
  }, 
  "properties": {
    "average_bandwidth": {
      "default": 0, 
      "descrption": "Set custom average_bandwidth for the inbound network traffic\nfrom the VM to the logical network based on broadcast.\n", 
      "minimum": 0, 
      "title": "Average bandwidth in Mb/s", 
      "type": "int"
    }, 
    "burst_size": {
      "default": 0, 
      "descrption": "Set custom burst_size for the inbound network traffic\nfrom the VM to the logical network based on broadcast.\n", 
      "minimum": 0, 
      "title": "Burst size in bytes", 
      "type": "int"
    }, 
    "enabled": {
      "required": true, 
      "type": "boolean"
    }, 
    "peak_bandwidth": {
      "default": 0, 
      "descrption": "Set custom peak_bandwidth for the inbound network traffic\nfrom the VM to the logical network based on broadcast.\n", 
      "minimum": 0, 
      "title": "Peak bandwidth in Mb/s", 
      "type": "int"
    }, 
    "resource_type": {
      "default": "IngressRateLimiter", 
      "description": "Type rate limiter", 
      "enum": [
        "IngressRateLimiter", 
        "IngressBroadcastRateLimiter", 
        "EgressRateLimiter"
      ], 
      "required": true, 
      "type": "string"
    }
  }, 
  "title": "A shaper that specifies egress rate properties in Mb/s", 
  "type": "object"
}

EndpointPolicy (type)

{
  "additionalProperties": false, 
  "description": "Ordered list of Endpoint Rules ordered by sequence number of the entries. The maximum number of policies is 25.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "EndpointPolicy", 
  "module_id": "PolicyGuestIntrospection", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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"
    }, 
    "endpoint_rules": {
      "items": {
        "$ref": "EndpointRule
      }, 
      "required": false, 
      "title": "Endpoint Rules that are a part of this EndpointPolicy", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": {
      "default": 0, 
      "description": "This field is used to resolve conflicts between maps across domains.", 
      "maximum": 499, 
      "minimum": 0, 
      "required": false, 
      "title": "Precedence to resolve conflicts across Domains", 
      "type": "int"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Contains ordered list of Endpoint Rules\n", 
  "type": "object"
}

EndpointRule (type)

{
  "additionalProperties": false, 
  "description": "Endpoint Rule comes from user configuration. User configures Endpoint Rule to specify what services are applied on the groups.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "EndpointRule", 
  "module_id": "PolicyGuestIntrospection", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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"
    }, 
    "groups": {
      "description": "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.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 50, 
      "required": true, 
      "title": "group paths", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": {
      "default": 0, 
      "description": "This field is used to resolve conflicts between multiple entries under EndpointPolicy. It will be system default value when not specified by user.", 
      "maximum": 499, 
      "minimum": 0, 
      "required": false, 
      "title": "Sequence number of this Entry", 
      "type": "int"
    }, 
    "service_profiles": {
      "description": "The policy paths of service profiles are listed here. It pecifies what services are applied on the group. Currently only one is allowed.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 1, 
      "required": true, 
      "title": "Names of service profiles", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Endpoint Rule for guest introspection.", 
  "type": "object"
}

EnforcedStatusDetailsNsxT (type)

{
  "additionalProperties": false, 
  "description": "Detailed Realized Status of an intent object on an NSX-T type of enforcement point. This is a detailed view of the Realized Status of an intent object from an NSX-T enforcement point perspective.", 
  "id": "EnforcedStatusDetailsNsxT", 
  "module_id": "PolicyRealizationStatus", 
  "properties": {
    "enforced_status_info": {
      "$ref": "EnforcedStatusInfoNsxT, 
      "description": "Information about the realized status of the intent on this enforcement point. Some very recent changes may be excluded when preparing this information, which is indicated by Pending Changes Info.", 
      "readonly": true, 
      "title": "Enforced Realized Status Info"
    }, 
    "pending_changes_info": {
      "$ref": "PendingChangesInfoNsxT, 
      "description": "Information about pending changes, if any, that aren't reflected in the Enforced Realized Status.", 
      "readonly": true, 
      "title": "Pending Changes Info"
    }
  }, 
  "title": "NSX-T Enforced Realized Status Details", 
  "type": "object"
}

EnforcedStatusInfoNsxT (type)

{
  "additionalProperties": false, 
  "description": "Information about the realized status of the intent object on an NSX-T type of enforcement point. Some very recent changes may be excluded when preparing this information, which is indicated by Pending Changes Info. In addition to the realized status across all scopes, this information holds details about enforced realized status per scope.", 
  "id": "EnforcedStatusInfoNsxT", 
  "module_id": "PolicyRealizationStatus", 
  "properties": {
    "enforced_status": {
      "$ref": "EnforcedStatusNsxT, 
      "description": "Consolidated Realized Status of an Intent object across all scopes of an NSX-T type of enforcement point.", 
      "readonly": true, 
      "title": "Enforced Realized Status"
    }, 
    "enforced_status_per_scope": {
      "description": "List of Enforced Realized Status per Scope.", 
      "items": {
        "$ref": "EnforcedStatusPerScopeNsxT
      }, 
      "readonly": true, 
      "title": "List of Enforced Realized Status per Scope", 
      "type": "array"
    }
  }, 
  "title": "NSX-T Enforced Realized Status Information", 
  "type": "object"
}

EnforcedStatusNsxT (type)

{
  "additionalProperties": false, 
  "description": "NSX-T Enforced Status.", 
  "id": "EnforcedStatusNsxT", 
  "module_id": "PolicyRealizationStatus", 
  "properties": {
    "status": {
      "$ref": "RuntimeState, 
      "description": "Enforced Realized Status.", 
      "readonly": true, 
      "title": "Enforced Realized Status"
    }, 
    "status_message": {
      "description": "Status Message conveying hints depending on the status value.", 
      "readonly": true, 
      "title": "Status Message", 
      "type": "string"
    }
  }, 
  "title": "NSX-T Enforced Status", 
  "type": "object"
}

EnforcedStatusPerScopeNsxT (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "description": "NSX-T Detailed Realized Status Per Scope.", 
  "id": "EnforcedStatusPerScopeNsxT", 
  "module_id": "PolicyRealizationStatus", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "resource_type"
  }, 
  "properties": {
    "resource_type": {
      "description": "Enforced Realized Status Per Scope Resource Type.", 
      "enum": [
        "TransportNodeSpanEnforcedStatus"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Resource Type", 
      "type": "string"
    }
  }, 
  "title": "NSX-T Enforced Realized Status Per Scope", 
  "type": "object"
}

EnforcedStatusPerTransportNode (type)

{
  "additionalProperties": false, 
  "description": "Detailed Realized Status Per Transport Node.", 
  "id": "EnforcedStatusPerTransportNode", 
  "module_id": "PolicyRealizationStatus", 
  "properties": {
    "display_name": {
      "description": "Display name of the transport node.", 
      "readonly": true, 
      "title": "Transport Node Display Name", 
      "type": "string"
    }, 
    "enforced_status": {
      "$ref": "EnforcedStatusNsxT, 
      "description": "Realized Status of an Intent object on this Transport Node.", 
      "readonly": true, 
      "title": "Enforced Realized Status"
    }, 
    "nsx_id": {
      "description": "UUID identifying uniquely the Transport Node.", 
      "readonly": true, 
      "title": "Transport Node Identifier", 
      "type": "string"
    }, 
    "path": {
      "description": "Policy Path referencing the transport node.", 
      "readonly": true, 
      "title": "Transport Node Path", 
      "type": "string"
    }
  }, 
  "title": "Enforced Realized Status Per Transport Node", 
  "type": "object"
}

EnforcementPoint (type)

{
  "additionalProperties": false, 
  "description": "Enforcement point is the endpoint where policy configurations are applied.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "EnforcementPoint", 
  "module_id": "PolicyEnforcementPointManagement", 
  "policy_hierarchical_children": [
    "ChildPolicyEdgeCluster", 
    "ChildPolicyTransportZone"
  ], 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "auto_enforce": {
      "default": true, 
      "description": "Auto enforce flag suggests whether the policy objects shall be automatically enforced on this enforcement point or not. When this flag is set to true, all policy objects will be automatically enforced on this enforcement point. If this flag is set to false, user shall rely on the usual means of realization, i.e., deployment maps.", 
      "title": "Auto Enforce Flag", 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "connection_info": {
      "$ref": "EnforcementPointConnectionInfo, 
      "description": "Connection Info of the Enforcement Point.", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }, 
    "version": {
      "description": "Version of the Enforcement point.", 
      "readonly": true, 
      "title": "Enforcement point Version", 
      "type": "string"
    }
  }, 
  "title": "Enforcement Point", 
  "type": "object"
}

EnforcementPointConnectionInfo (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "description": "Contains information required to connect to enforcement point.", 
  "id": "EnforcementPointConnectionInfo", 
  "module_id": "PolicyEnforcementPointManagement", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "resource_type"
  }, 
  "properties": {
    "enforcement_point_address": {
      "description": "Value of this property could be Hostname or IP. For instance: - On an NSX-T MP running on default port, the value could be \"10.192.1.1\" - On an NSX-T MP running on custom port, the value could be \"192.168.1.1:32789\" - On an NSX-T MP in VMC deployments, the value could be \"192.168.1.1:5480/nsxapi\"", 
      "required": true, 
      "title": "Enforcement Point Address", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "Resource Type of Enforcement Point Connection Info.", 
      "enum": [
        "NSXTConnectionInfo", 
        "NSXVConnectionInfo", 
        "CvxConnectionInfo"
      ], 
      "required": true, 
      "title": "Connection Info Resource Type", 
      "type": "string"
    }
  }, 
  "title": "Enforcement Point Connection Info", 
  "type": "object"
}

EnforcementPointListRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "Enforcement point list request parameters.", 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "EnforcementPointListRequestParameters", 
  "module_id": "PolicyEnforcementPointManagement", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Enforcement Point List Request Parameters", 
  "type": "object"
}

EnforcementPointListResult (type)

{
  "additionalProperties": false, 
  "description": "Paged collection of enforcement points.", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "EnforcementPointListResult", 
  "module_id": "PolicyEnforcementPointManagement", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Enforcement Point list Results.", 
      "items": {
        "$ref": "EnforcementPoint
      }, 
      "required": true, 
      "title": "Enforcement Point List Results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of EnforcementPoints", 
  "type": "object"
}

EntityInstanceCountConstraintExpression (type)

{
  "additionalProperties": false, 
  "description": "Represents the leaf level constraint to restrict the number instances of an entity type can be created. This is useful in restricting number of CGWs or MGWs or Providers that can created in a system.", 
  "extends": {
    "$ref": "ConstraintExpression
  }, 
  "id": "EntityInstanceCountConstraintExpression", 
  "module_id": "PolicyConstraints", 
  "polymorphic-type-descriptor": {
    "type-identifier": "EntityInstanceCountConstraintExpression"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "count": {
      "description": "Instance count.", 
      "required": true, 
      "title": "Instance count.", 
      "type": "integer"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "operator": {
      "required": true, 
      "title": "Operations supported '<' and '<='.", 
      "type": "string"
    }, 
    "resource_type": {
      "enum": [
        "ValueConstraintExpression", 
        "RelatedAttributeConditionalExpression", 
        "EntityInstanceCountConstraintExpression", 
        "FieldSanityConstraintExpression"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Represents the leaf level constraint to restrict the number instances of type.", 
  "type": "object"
}

EpochMsTimestamp (type)

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

ErrorResolverInfo (type)

{
  "additionalProperties": false, 
  "description": "Metadata related to a given error_id", 
  "id": "ErrorResolverInfo", 
  "module_id": "ErrorResolver", 
  "properties": {
    "error_id": {
      "required": true, 
      "title": "The error id for which metadata information is needed", 
      "type": "integer"
    }, 
    "resolver_present": {
      "required": true, 
      "title": "Indicates whether there is a resolver associated with the error or not", 
      "type": "boolean"
    }, 
    "user_metadata": {
      "$ref": "ErrorResolverUserMetadata, 
      "required": false, 
      "title": "User supplied metadata that might be required by the resolver"
    }
  }, 
  "type": "object"
}

ErrorResolverInfoList (type)

{
  "additionalProperties": false, 
  "id": "ErrorResolverInfoList", 
  "module_id": "ErrorResolver", 
  "properties": {
    "results": {
      "items": {
        "$ref": "ErrorResolverInfo
      }, 
      "required": true, 
      "title": "ErrorResolverInfo list", 
      "type": "array"
    }
  }, 
  "title": "Collection of all registered ErrorResolverInfo", 
  "type": "object"
}

ErrorResolverMetadata (type)

{
  "additionalProperties": false, 
  "description": "Error along with its metadata", 
  "id": "ErrorResolverMetadata", 
  "module_id": "ErrorResolver", 
  "properties": {
    "entity_id": {
      "required": true, 
      "title": "The entity/node UUID where the error has occurred.", 
      "type": "string"
    }, 
    "error_id": {
      "required": true, 
      "title": "The error id as reported by the entity where the error occurred.", 
      "type": "integer"
    }, 
    "system_metadata": {
      "$ref": "ErrorResolverSystemMetadata, 
      "required": false, 
      "title": "This can come from some external system like syslog collector"
    }, 
    "user_metadata": {
      "$ref": "ErrorResolverUserMetadata, 
      "required": false, 
      "title": "User supplied metadata that might be required by the resolver"
    }
  }, 
  "type": "object"
}

ErrorResolverMetadataList (type)

{
  "additionalProperties": false, 
  "description": "List of errors with their metadata", 
  "id": "ErrorResolverMetadataList", 
  "module_id": "ErrorResolver", 
  "properties": {
    "errors": {
      "items": {
        "$ref": "ErrorResolverMetadata
      }, 
      "required": true, 
      "title": "List of errors with their corresponding metadata.", 
      "type": "array"
    }
  }, 
  "type": "object"
}

ErrorResolverSystemMetadata (type)

{
  "additionalProperties": false, 
  "description": "Metadata fetched from an external system like Syslog or LogInsight.", 
  "id": "ErrorResolverSystemMetadata", 
  "module_id": "ErrorResolver", 
  "properties": {
    "value": {
      "required": false, 
      "title": "The value fetched from another system", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ErrorResolverUserInputData (type)

{
  "additionalProperties": false, 
  "description": "Corresponds to one property entered by the user", 
  "id": "ErrorResolverUserInputData", 
  "module_id": "ErrorResolver", 
  "properties": {
    "data_type": {
      "enum": [
        "TEXT", 
        "NUMBER", 
        "PASSWORD"
      ], 
      "required": true, 
      "title": "The datatype of the given property. Useful for data validation", 
      "type": "string"
    }, 
    "property_name": {
      "required": true, 
      "title": "Name of the property supplied by the user", 
      "type": "string"
    }, 
    "property_value": {
      "required": false, 
      "title": "The value associated with the above property", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ErrorResolverUserMetadata (type)

{
  "additionalProperties": false, 
  "description": "User supplied metadata needed for resolving errors", 
  "id": "ErrorResolverUserMetadata", 
  "module_id": "ErrorResolver", 
  "properties": {
    "user_input_list": {
      "items": {
        "$ref": "ErrorResolverUserInputData
      }, 
      "required": false, 
      "title": "List of user supplied input data.", 
      "type": "array"
    }
  }, 
  "type": "object"
}

EtherTypeServiceEntry (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ServiceEntry
  }, 
  "id": "EtherTypeServiceEntry", 
  "module_id": "Policy", 
  "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: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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"
    }, 
    "ether_type": {
      "required": true, 
      "title": "Type of the encapsulated protocol", 
      "type": "integer"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": [
        "IPProtocolServiceEntry", 
        "IGMPTypeServiceEntry", 
        "ICMPTypeServiceEntry", 
        "ALGTypeServiceEntry", 
        "L4PortSetServiceEntry", 
        "EtherTypeServiceEntry", 
        "NestedServiceServiceEntry"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "A ServiceEntry that represents an ethertype protocol", 
  "type": "object"
}

EthernetHeader (type)

{
  "additionalProperties": false, 
  "id": "EthernetHeader", 
  "module_id": "Traceflow", 
  "properties": {
    "dst_mac": {
      "description": "The destination MAC address of form: \"^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$\". For example: 00:00:00:00:00:00.", 
      "required": false, 
      "title": "Destination MAC address of the Ethernet header", 
      "type": "string"
    }, 
    "eth_type": {
      "default": 2048, 
      "description": "This field defaults to IPv4.", 
      "maximum": 65535, 
      "minimum": 1, 
      "required": false, 
      "title": "The value of the type field to be put into the Ethernet header", 
      "type": "integer"
    }, 
    "src_mac": {
      "description": "The source MAC address of form: \"^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$\". For example: 00:00:00:00:00:00.", 
      "required": false, 
      "title": "Source MAC address of the Ethernet header", 
      "type": "string"
    }
  }, 
  "type": "object"
}

Evaluation (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "description": "Criterion Evaluation is the basic logical condition to evaluate whether the event could be potentially met.", 
  "id": "Evaluation", 
  "module_id": "PolicyReaction", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "resource_type"
  }, 
  "properties": {
    "resource_type": {
      "description": "Criterion Evaluation resource type.", 
      "enum": [
        "SourceFieldEvaluation"
      ], 
      "required": true, 
      "title": "Resource Type", 
      "type": "string"
    }
  }, 
  "title": "Criterion Evaluation", 
  "type": "object"
}

Event (type)

{
  "additionalProperties": false, 
  "description": "The Event is the criterion or criteria applied to the source and, when met, prompt Policy to run the action. All Reaction Events are constructed with reference to the object, the \"source\", that is logically deemed to be the object upon which the Event in question initially occurred upon. Some example events include: - New object was created. - Change in realization state. - Specific API is called.", 
  "id": "Event", 
  "module_id": "PolicyReaction", 
  "properties": {
    "criteria": {
      "description": "Criteria applied to the source and, if satisfied, would trigger the action. Criteria is composed of criterions. In order for the Criteria to be met, only one of the criterion must be fulfilled (implicit OR).", 
      "items": {
        "$ref": "Criterion
      }, 
      "title": "Event Criteria", 
      "type": "array"
    }, 
    "source": {
      "$ref": "Source, 
      "description": "Source that is logically deemed to be the \"object\" upon which the Event in question initially occurred upon.", 
      "required": true, 
      "title": "Event Source"
    }
  }, 
  "title": "Reaction Event", 
  "type": "object"
}

EvpnConfig (type)

{
  "additionalProperties": false, 
  "description": "Evpn Configuration.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "EvpnConfig", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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"
    }, 
    "encapsulation_method": {
      "$ref": "EvpnEncapConfig, 
      "description": "Encapsulation method for EVPN service that is used by the transport layer.", 
      "required": false, 
      "title": "Encapsulation method for EVPN."
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "mode": {
      "default": "DISABLE", 
      "description": "In INLINE mode, edge nodes participate both in the BGP EVPN control plane route exchange and in data path tunneling between edge nodes and data center gateways. In ROUTE_SERVER mode, edge nodes participate in the BGP EVPN control plane route exchanges only and do not participate in the data forwarding, i.e., the data path tunnels are directly established between the hypervisors and the data center gateways. DISABLE mode disables EVPN service capability.", 
      "enum": [
        "INLINE", 
        "ROUTE_SERVER", 
        "DISABLE"
      ], 
      "required": false, 
      "title": "EVPN service mode", 
      "type": "string"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Evpn Configuration", 
  "type": "object"
}

EvpnEncapConfig (type)

{
  "additionalProperties": false, 
  "description": "Encapsulation method for EVPN.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "EvpnEncapConfig", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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"
    }, 
    "evpn_tenant_config_path": {
      "required": false, 
      "title": "EVPN tenant config path", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }, 
    "vni_pool_path": {
      "required": false, 
      "title": "vni pool path", 
      "type": "string"
    }
  }, 
  "title": "Encapsulation method for EVPN", 
  "type": "object"
}

EvpnTenantConfig (type)

{
  "additionalProperties": false, 
  "description": "This resource is relevant only when Evpn Service is configured in ROUTE-SERVER mode. The resource defines Vlans to VNIs mappings used by Evpn tenant VMs for overlay VXLAN transmission when attached to vRouter. The resource contains overlay transport_zone_path and vni_pool_path to orchestrate creation of child Logical-Switches.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "EvpnTenantConfig", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mappings": {
      "description": "This property specifies a mapping spec of incoming Evpn tenant vlan-ids to VXLAN VNIs used for overlay transmission to Physical-Gateways used by vRouters.", 
      "items": {
        "$ref": "VlanVniRangePair
      }, 
      "maxItems": 2000, 
      "minItems": 1, 
      "required": true, 
      "title": "VLANs to VNIs mapping spec", 
      "type": "array"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "transport_zone_path": {
      "description": "Policy path to transport zone. Only overlay transport zone is supported.", 
      "required": true, 
      "title": "Policy path to the transport zone", 
      "type": "string"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }, 
    "vni_pool_path": {
      "description": "Policy path to the vni pool used for Evpn in ROUTE-SERVER mode.", 
      "required": true, 
      "title": "Policy path to the vni pool", 
      "type": "string"
    }
  }, 
  "title": "Evpn Tenant Configuration for Evpn in ROUTE-SERVER mode.", 
  "type": "object"
}

EvpnTunnelEndpointConfig (type)

{
  "additionalProperties": false, 
  "description": "Evpn Tunnel Endpoint Configuration.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "EvpnTunnelEndpointConfig", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "edge_path": {
      "required": true, 
      "title": "edge path", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "local_addresses": {
      "items": {
        "$ref": "IPv4Address
      }, 
      "maxItems": 1, 
      "minItems": 1, 
      "required": true, 
      "title": "local addresses", 
      "type": "array"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "mtu": {
      "maximum": 9100, 
      "minimum": 64, 
      "required": false, 
      "title": "MTU", 
      "type": "int"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Evpn Tunnel Endpoint Configuration", 
  "type": "object"
}

ExportRequestParameter (type)

{
  "additionalProperties": false, 
  "description": "This holds the request parameters required to invoke export task.", 
  "id": "ExportRequestParameter", 
  "module_id": "PolicyTask", 
  "properties": {
    "draft_path": {
      "description": "Policy path of a draft which is to be exported. If not provided, current firewall configuration will then be exported.", 
      "required": false, 
      "title": "Policy path of draft", 
      "type": "string"
    }, 
    "passphrase": {
      "description": "Passphrase to sign exported files. The passphrase specified must be at least 8 characters in length and must contain at least one lowercase, one uppercase, one numeric character and one non-space special character.", 
      "minLength": 8, 
      "pattern": "^$|^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)(?=.*[^a-zA-Z\\d\\s]).{8,}$", 
      "required": true, 
      "sensitive": true, 
      "title": "Passphrase to sign exported files", 
      "type": "string", 
      "validation_msg_key": "com.vmware.nsx.validation.constraints.BackupRestore.weak_passprase.message"
    }
  }, 
  "title": "Export task request parameters", 
  "type": "object"
}

ExportTask (type)

{
  "additionalProperties": false, 
  "description": "This object holds the information of the export task.", 
  "extends": {
    "$ref": "PolicyTask
  }, 
  "id": "ExportTask", 
  "module_id": "PolicyTask", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "async_response_available": {
      "display": {
        "order": 13
      }, 
      "readonly": true, 
      "title": "True if response for asynchronous request is available", 
      "type": "boolean"
    }, 
    "cancelable": {
      "display": {
        "order": 8
      }, 
      "readonly": true, 
      "title": "True if this task can be canceled", 
      "type": "boolean"
    }, 
    "description": {
      "display": {
        "order": 2
      }, 
      "readonly": true, 
      "title": "Description of the task", 
      "type": "string"
    }, 
    "draft_path": {
      "description": "Policy path of a draft if this is an export task to export draft configuration.", 
      "readonly": true, 
      "title": "Policy path of a draft", 
      "type": "string"
    }, 
    "end_time": {
      "$ref": "EpochMsTimestamp, 
      "display": {
        "order": 6
      }, 
      "readonly": true, 
      "title": "The end time of the task in epoch milliseconds"
    }, 
    "exported_file": {
      "description": "Name of the exported file generated after completion of export task.", 
      "readonly": true, 
      "title": "Name of the exported file", 
      "type": "string"
    }, 
    "failure_msg": {
      "description": "This property holds the reason of the task failure, if any.", 
      "readonly": true, 
      "title": "Reason of the task failure", 
      "type": "string"
    }, 
    "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": "Export task information", 
  "type": "object"
}

Expression (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "description": "All the nodes of the expression extend from this abstract class. This is present for extensibility.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "Expression", 
  "module_id": "Policy", 
  "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: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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", 
        "ExternalIDExpression", 
        "PathExpression", 
        "IdentityGroupExpression"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Base class for each node of the expression", 
  "type": "object"
}

ExternalIDExpression (type)

{
  "additionalProperties": false, 
  "description": "Represents external ID expressions in the form of an array, to support addition of objects like virtual interfaces, virtual machines, CloudNativeServiceInstance PhysicalServer to a group.", 
  "extends": {
    "$ref": "Expression
  }, 
  "id": "ExternalIDExpression", 
  "module_id": "Policy", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ExternalIDExpression"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "external_ids": {
      "description": "This array can consist of one or more external IDs for the specified member type.", 
      "items": {
        "type": "string"
      }, 
      "minItems": 1, 
      "required": true, 
      "title": "Array of external IDs for the specified member type", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "member_type": {
      "enum": [
        "VirtualMachine", 
        "VirtualNetworkInterface", 
        "CloudNativeServiceInstance", 
        "PhysicalServer"
      ], 
      "required": true, 
      "title": "External ID member type", 
      "type": "string"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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", 
        "ExternalIDExpression", 
        "PathExpression", 
        "IdentityGroupExpression"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "External ID expression node", 
  "type": "object"
}

FIPSGlobalConfig (type)

{
  "additionalProperties": false, 
  "description": "Global configuration", 
  "id": "FIPSGlobalConfig", 
  "module_id": "Policy", 
  "properties": {
    "lb_fips_enabled": {
      "default": false, 
      "description": "When this flag is set to true FIPS mode will be set on ssl encryptions of load balancer feature.", 
      "required": false, 
      "title": "A flag to turn on or turn off the FIPS compliance of load balancer feature.", 
      "type": "boolean"
    }
  }, 
  "title": "Global configuration", 
  "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"
}

FeatureCompatibilityInfo (type)

{
  "description": "Feature status information indicating site configuration compatibility with global manager configuration.", 
  "id": "FeatureCompatibilityInfo", 
  "module_id": "GmConfigOnboarding", 
  "properties": {
    "details": {
      "items": {
        "$ref": "CompatibilityDetail
      }, 
      "maxItems": 10, 
      "readonly": true, 
      "required": false, 
      "type": "array"
    }, 
    "feature": {
      "$ref": "OnboardingFeatureInfo, 
      "readonly": true, 
      "required": true
    }, 
    "status": {
      "$ref": "OnboardingCompatibilityStatus, 
      "readonly": true, 
      "required": true, 
      "title": "Compatibility Status"
    }
  }, 
  "title": "Feature Compatibility Info", 
  "type": "object"
}

FeatureConflictInfo (type)

{
  "description": "Feature status information with number of conflicting entities and its total count associated with the feature.", 
  "id": "FeatureConflictInfo", 
  "module_id": "GmConfigOnboarding", 
  "properties": {
    "conflict_count": {
      "description": "Number of conflicting entities with global entities in the feature during an onboarding stage.", 
      "readonly": true, 
      "required": false, 
      "title": "Conflict Count", 
      "type": "integer"
    }, 
    "feature": {
      "$ref": "OnboardingFeatureInfo, 
      "readonly": true, 
      "required": false
    }, 
    "total_count": {
      "description": "Total number of entities in the feature during an onboarding stage.", 
      "readonly": true, 
      "required": false, 
      "title": "Total Count", 
      "type": "integer"
    }
  }, 
  "title": "Feature Conflict Info", 
  "type": "object"
}

FeaturePermission (type)

{
  "id": "FeaturePermission", 
  "module_id": "AAA", 
  "properties": {
    "feature": {
      "required": true, 
      "title": "Feature Id", 
      "type": "string"
    }, 
    "feature_description": {
      "title": "Feature Description", 
      "type": "string"
    }, 
    "feature_name": {
      "title": "Feature Name", 
      "type": "string"
    }, 
    "is_execute_recommended": {
      "readonly": true, 
      "title": "Is execute recommended", 
      "type": "boolean"
    }, 
    "is_internal": {
      "readonly": true, 
      "title": "Is internal", 
      "type": "boolean"
    }, 
    "permission": {
      "enum": [
        "crud", 
        "read", 
        "execute", 
        "none"
      ], 
      "required": true, 
      "title": "Permission", 
      "type": "string"
    }
  }, 
  "title": "Feature Permission", 
  "type": "object"
}

FeaturePermissionArray (type)

{
  "additionalProperties": false, 
  "id": "FeaturePermissionArray", 
  "module_id": "AAA", 
  "properties": {
    "feature_permissions": {
      "items": {
        "$ref": "FeaturePermission
      }, 
      "required": true, 
      "title": "Array of FeaturePermission", 
      "type": "array"
    }
  }, 
  "type": "object"
}

FeaturePermissionListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "FeaturePermissionListResult", 
  "module_id": "AAA", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "FeaturePermission
      }, 
      "required": true, 
      "title": "List results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

FeaturePermissionRequestParameters (type)

{
  "additionalProperties": false, 
  "id": "FeaturePermissionRequestParameters", 
  "module_id": "PolicyAuthz", 
  "properties": {
    "feature_name": {
      "required": true, 
      "title": "Feature name", 
      "type": "string"
    }, 
    "object_path": {
      "required": true, 
      "title": "Exact object Policy path", 
      "type": "string"
    }
  }, 
  "title": "RBAC Objects qualifier", 
  "type": "object"
}

FeatureSet (type)

{
  "additionalProperties": false, 
  "description": "Represents list of features required to view the widget.", 
  "id": "FeatureSet", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "properties": {
    "feature_list": {
      "description": "List of features required for to view widget.", 
      "items": {
        "type": "string"
      }, 
      "title": "List of features required for to view wdiget", 
      "type": "array"
    }, 
    "require_all_permissions": {
      "description": "Flag for specifying if permission to all features is required If set to false, then if there is permission for any of the feature from feature list, widget will be available.", 
      "title": "Flag for specifying if permission to all features is required", 
      "type": "boolean"
    }
  }, 
  "title": "List of features required to view the widget", 
  "type": "object"
}

FeatureSummary (type)

{
  "description": "Feature summary defining overall conflicting count against total number of entities.", 
  "id": "FeatureSummary", 
  "module_id": "GmConfigOnboarding", 
  "properties": {
    "total_conflict_count": {
      "description": "Total number of conflicting entities with global entities accross all features during an onboarding stage.", 
      "readonly": true, 
      "required": false, 
      "title": "Total Conflict Count", 
      "type": "integer"
    }, 
    "total_count": {
      "description": "Total number of entities across all features during an onboarding stage.", 
      "readonly": true, 
      "required": false, 
      "title": "Total Count", 
      "type": "integer"
    }
  }, 
  "title": "Feature Summary", 
  "type": "object"
}

FeatureSummaryRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "Feature summary request parameters for a site.", 
  "id": "FeatureSummaryRequestParameters", 
  "module_id": "GmConfigOnboarding", 
  "properties": {
    "feature": {
      "$ref": "UnsupportedFeature, 
      "readonly": true, 
      "required": true
    }
  }, 
  "title": "Onboarding Feature Summary Request Parameters", 
  "type": "object"
}

FederationComponentUpgradeStatus (type)

{
  "additionalProperties": false, 
  "id": "FederationComponentUpgradeStatus", 
  "module_id": "FederationUpgrade", 
  "properties": {
    "component_type": {
      "readonly": true, 
      "required": false, 
      "title": "Component type for the upgrade status", 
      "type": "string"
    }, 
    "current_version_node_summary": {
      "items": {
        "$ref": "FederationNodeSummary
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Mapping of current versions of nodes and counts of nodes at the respective versions.", 
      "type": "array"
    }, 
    "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"
    }, 
    "target_version": {
      "readonly": true, 
      "required": false, 
      "title": "Target component version", 
      "type": "string"
    }
  }, 
  "type": "object"
}

FederationConfig (type)

{
  "additionalProperties": false, 
  "description": "Global Manager federation configuration. This configuration is distributed to all Sites participating in federation.", 
  "id": "FederationConfig", 
  "module_id": "PolicySiteGM", 
  "properties": {
    "site_config": {
      "items": {
        "$ref": "SiteFederationConfig
      }, 
      "readonly": true, 
      "title": "Federation configurations of all Sites", 
      "type": "array"
    }
  }, 
  "title": "Global Manager federation configuration", 
  "type": "object"
}

FederationConnectivityConfig (type)

{
  "additionalProperties": false, 
  "description": "Additional configuration required for federation.", 
  "id": "FederationConnectivityConfig", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "global_overlay_id": {
      "description": "Global id for by Layer3 services for federation usecases.", 
      "readonly": true, 
      "title": "Auto generated federation global 24-bit id", 
      "type": "integer"
    }
  }, 
  "title": "Federation connectivity configuration", 
  "type": "object"
}

FederationGatewayConfig (type)

{
  "additionalProperties": false, 
  "description": "Additional gateway configuration required for federation", 
  "extends": {
    "$ref": "FederationConnectivityConfig
  }, 
  "id": "FederationGatewayConfig", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "global_overlay_id": {
      "description": "Global id for by Layer3 services for federation usecases.", 
      "readonly": true, 
      "title": "Auto generated federation global 24-bit id", 
      "type": "integer"
    }, 
    "site_allocation_indices": {
      "description": "Indicies for cross site allocation for edge cluster and its members referred by gateway.", 
      "items": {
        "$ref": "SiteAllocationIndexForEdge
      }, 
      "readonly": true, 
      "title": "Indicies for cross site allocation\n", 
      "type": "array"
    }, 
    "transit_segment_id": {
      "description": "Global UUID for transit segment id to be used by Layer2 services for federation usecases.", 
      "readonly": true, 
      "title": "Auto generated federation global id for transit segment", 
      "type": "string"
    }
  }, 
  "title": "Federation gateway configuration", 
  "type": "object"
}

FederationInvalidConfigurationDetailsResponse (type)

{
  "additionalProperties": false, 
  "id": "FederationInvalidConfigurationDetailsResponse", 
  "module_id": "GmConfigOnboarding", 
  "properties": {
    "feature": {
      "$ref": "OnboardingFeatureInfo, 
      "description": "Federation feature with invalid configuration for onboarding a site.", 
      "readonly": true, 
      "required": false, 
      "title": "Feature information"
    }, 
    "invalid_config_summary": {
      "items": {
        "$ref": "InvalidConfigSummary
      }, 
      "maxItems": 8, 
      "readonly": true, 
      "required": false, 
      "type": "array"
    }, 
    "total_count": {
      "description": "Total resource count in invalid configuration.", 
      "readonly": true, 
      "required": true, 
      "title": "Total Resource Count", 
      "type": "integer"
    }
  }, 
  "title": "Federation Invalid Configuration Details Response", 
  "type": "object"
}

FederationNodeSummary (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "FederationNodeSummary", 
  "module_id": "FederationUpgrade", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "node_count": {
      "description": "Number of nodes of the type and at the component version.", 
      "readonly": true, 
      "required": true, 
      "title": "Count of nodes", 
      "type": "int"
    }, 
    "version": {
      "readonly": true, 
      "required": true, 
      "title": "Component version", 
      "type": "string"
    }
  }, 
  "type": "object"
}

FederationUpgradeSummary (type)

{
  "additionalProperties": false, 
  "description": "Provides upgrade summary for a specific site.", 
  "id": "FederationUpgradeSummary", 
  "module_id": "FederationUpgrade", 
  "properties": {
    "component_status": {
      "items": {
        "$ref": "FederationComponentUpgradeStatus
      }, 
      "readonly": true, 
      "required": true, 
      "title": "List of component statuses", 
      "type": "array"
    }, 
    "current_version": {
      "description": "This is NSX version for the site.", 
      "readonly": true, 
      "required": true, 
      "title": "Current version of the site", 
      "type": "string"
    }, 
    "gpm_name": {
      "description": "Name of the global manager if present.", 
      "readonly": true, 
      "required": false, 
      "title": "Name of the global manager", 
      "type": "string"
    }, 
    "id": {
      "description": "Unique identifier of this resource.", 
      "readonly": true, 
      "required": true, 
      "title": "UUID of this resource", 
      "type": "string"
    }, 
    "last_upgrade_timestamp": {
      "description": "Indicates the time when the site was upgraded.", 
      "readonly": true, 
      "required": false, 
      "title": "Last upgrade timestamp", 
      "type": "string"
    }, 
    "name": {
      "description": "Name of the site.", 
      "readonly": true, 
      "required": false, 
      "title": "Name of the site", 
      "type": "string"
    }, 
    "overall_upgrade_status": {
      "enum": [
        "SUCCESS", 
        "FAILED", 
        "IN_PROGRESS", 
        "NOT_STARTED", 
        "PAUSED"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Status of upgrade", 
      "type": "string"
    }, 
    "site_id": {
      "description": "This is the Site Manager generated UUID for every NSX deployment.", 
      "readonly": true, 
      "required": true, 
      "title": "UUID of the site", 
      "type": "string"
    }, 
    "site_ip": {
      "description": "IP address of the site.", 
      "readonly": true, 
      "required": true, 
      "title": "Site IP", 
      "type": "string"
    }, 
    "site_type": {
      "description": "Type of this site.", 
      "enum": [
        "ACTIVE_GM_SITE", 
        "STANDBY_GM_SITE", 
        "NON_GM_SITE"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Site type", 
      "type": "string"
    }, 
    "target_version": {
      "description": "This is NSX target version for the site, if it is undergoing upgrade.", 
      "readonly": true, 
      "required": false, 
      "title": "Target version for the site", 
      "type": "string"
    }
  }, 
  "title": "Upgrade Summary", 
  "type": "object"
}

FederationUpgradeSummaryListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "FederationUpgradeSummaryListRequestParameters", 
  "module_id": "FederationUpgrade", 
  "properties": {
    "current_version": {
      "description": "Get upgrade information from sites are at a given version.", 
      "readonly": false, 
      "required": false, 
      "title": "Filter on site current_version", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

FederationUpgradeSummaryListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "FederationUpgradeSummaryListResult", 
  "module_id": "FederationUpgrade", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "FederationUpgradeSummary
      }, 
      "readonly": true, 
      "title": "Paged collection of site upgrade information", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of site upgrade information", 
  "type": "object"
}

FieldSanityConstraintExpression (type)

{
  "additionalProperties": false, 
  "description": "Represents the field value constraint to constrain specified field value based on defined sanity checks. Example - For DNS.upstream_servers, all the IP addresses must either be public or private.   {     \"target\": {       \"target_resource_type\": \"DnsForwarderZone\",       \"attribute\": \"upstreamServers\",       \"path_prefix\": \"/infra/dns-forwarder-zones/\"      },      \"constraint_expression\": {        \"resource_type\": \"FieldSanityConstraintExpression\",        \"operator\": \"OR\",        \"checks\": [\"ALL_PUBLIC_IPS\", \"ALL_PRIVATE_IPS\"]      }   }", 
  "extends": {
    "$ref": "ConstraintExpression
  }, 
  "id": "FieldSanityConstraintExpression", 
  "module_id": "PolicyConstraints", 
  "polymorphic-type-descriptor": {
    "type-identifier": "FieldSanityConstraintExpression"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "checks": {
      "description": "List of sanity checks.", 
      "items": {
        "enum": [
          "ALL_PUBLIC_IPS", 
          "ALL_PRIVATE_IPS"
        ], 
        "type": "string"
      }, 
      "required": true, 
      "title": "Array of sanity checks to be performed on field value", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "operator": {
      "enum": [
        "OR", 
        "AND"
      ], 
      "required": true, 
      "title": "A conditional operator", 
      "type": "string"
    }, 
    "resource_type": {
      "enum": [
        "ValueConstraintExpression", 
        "RelatedAttributeConditionalExpression", 
        "EntityInstanceCountConstraintExpression", 
        "FieldSanityConstraintExpression"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Represents the field value sanity constraint", 
  "type": "object"
}

FieldSetting (type)

{
  "additionalProperties": false, 
  "description": "Field Setting.", 
  "id": "FieldSetting", 
  "module_id": "PolicyReaction", 
  "properties": {
    "field_pointer": {
      "description": "Field Pointer.", 
      "required": true, 
      "title": "Field Pointer", 
      "type": "string"
    }, 
    "value": {
      "$ref": "FieldSettingValue, 
      "description": "Value that the field must be set to.", 
      "required": true, 
      "title": "Value"
    }
  }, 
  "title": "FieldSetting", 
  "type": "object"
}

FieldSettingValue (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "description": "Field Setting Value.", 
  "id": "FieldSettingValue", 
  "module_id": "PolicyReaction", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "resource_type"
  }, 
  "properties": {
    "resource_type": {
      "description": "Field Setting Value resource type.", 
      "enum": [
        "ConstantFieldValue"
      ], 
      "required": true, 
      "title": "Resource Type", 
      "type": "string"
    }
  }, 
  "title": "Field Setting Value", 
  "type": "object"
}

FieldsFilterData (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "LiveTraceFilterData
  }, 
  "id": "FieldsFilterData", 
  "module_id": "LiveTrace", 
  "polymorphic-type-descriptor": {
    "type-identifier": "FieldsFilterData"
  }, 
  "properties": {
    "ip_info": {
      "$ref": "IpInfo, 
      "required": false, 
      "title": "IP address information"
    }, 
    "resource_type": {
      "default": "FieldsFilterData", 
      "enum": [
        "FieldsFilterData", 
        "PlainFilterData"
      ], 
      "required": true, 
      "title": "Filter type", 
      "type": "string"
    }, 
    "transport_info": {
      "$ref": "TransportInfo, 
      "required": false, 
      "title": "Transport layer information"
    }
  }, 
  "type": "object"
}

FieldsPacketData (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PacketData
  }, 
  "id": "FieldsPacketData", 
  "module_id": "Traceflow", 
  "polymorphic-type-descriptor": {
    "type-identifier": "FieldsPacketData"
  }, 
  "properties": {
    "arp_header": {
      "$ref": "ArpHeader, 
      "required": false, 
      "title": "The ARP header"
    }, 
    "eth_header": {
      "$ref": "EthernetHeader, 
      "required": false, 
      "title": "The ethernet header"
    }, 
    "frame_size": {
      "default": 128, 
      "description": "If the requested frame_size is too small (given the payload and traceflow metadata requirement of 16 bytes), the traceflow request will fail with an appropriate message.  The frame will be zero padded to the requested size.", 
      "maximum": 1000, 
      "minimum": 60, 
      "required": false, 
      "title": "Requested total size of the (logical) packet in bytes", 
      "type": "integer"
    }, 
    "ip_header": {
      "$ref": "Ipv4Header, 
      "required": false, 
      "title": "The IPv4 header"
    }, 
    "ipv6_header": {
      "$ref": "Ipv6Header, 
      "required": false, 
      "title": "The IPv6 header"
    }, 
    "payload": {
      "description": "Up to 1000 bytes of payload may be supplied (with a base64-encoded length of 1336 bytes.) Additional bytes of traceflow metadata will be appended to the payload. The payload contains any data the user wants to put after the transport header.", 
      "maxLength": 1336, 
      "required": false, 
      "title": "RFC3548 compatible base64-encoded payload", 
      "type": "string"
    }, 
    "resource_type": {
      "default": "FieldsPacketData", 
      "enum": [
        "BinaryPacketData", 
        "FieldsPacketData"
      ], 
      "required": true, 
      "title": "Packet configuration", 
      "type": "string"
    }, 
    "routed": {
      "required": false, 
      "title": "A flag, when set true, indicates that the traceflow packet is of L3 routing.", 
      "type": "boolean"
    }, 
    "transport_header": {
      "$ref": "TransportProtocolHeader, 
      "description": "This field contains a protocol that is above IP. It is not restricted to the 'transport' defined by the OSI model (e.g., ICMP is supported).", 
      "required": false, 
      "title": "The transport header"
    }, 
    "transport_type": {
      "default": "UNICAST", 
      "enum": [
        "BROADCAST", 
        "UNICAST", 
        "MULTICAST", 
        "UNKNOWN"
      ], 
      "required": false, 
      "title": "transport type of the traceflow packet", 
      "type": "string"
    }
  }, 
  "type": "object"
}

FileProperties (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "FileProperties", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "created_epoch_ms": {
      "required": true, 
      "title": "File creation time in epoch milliseconds", 
      "type": "integer"
    }, 
    "modified_epoch_ms": {
      "required": true, 
      "title": "File modification time in epoch milliseconds", 
      "type": "integer"
    }, 
    "name": {
      "pattern": "^[^/]+$", 
      "required": true, 
      "title": "File name", 
      "type": "string"
    }, 
    "size": {
      "required": true, 
      "title": "Size of the file in bytes", 
      "type": "integer"
    }
  }, 
  "title": "File properties", 
  "type": "object"
}

FilePropertiesListResult (type)

{
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "FilePropertiesListResult", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "FileProperties
      }, 
      "required": true, 
      "title": "File property results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "File properties query results", 
  "type": "object"
}

FileThumbprint (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "FileThumbprint", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "name": {
      "pattern": "^[^/]+$", 
      "required": true, 
      "title": "File name", 
      "type": "string"
    }, 
    "sha1": {
      "required": true, 
      "title": "File's SHA1 thumbprint", 
      "type": "string"
    }, 
    "sha256": {
      "required": true, 
      "title": "File's SHA256 thumbprint", 
      "type": "string"
    }
  }, 
  "title": "File thumbprint", 
  "type": "object"
}

FileTransferAuthenticationScheme (type)

{
  "additionalProperties": false, 
  "id": "FileTransferAuthenticationScheme", 
  "module_id": "BackupConfiguration", 
  "properties": {
    "password": {
      "sensitive": true, 
      "title": "Password to authenticate with", 
      "type": "string"
    }, 
    "scheme_name": {
      "enum": [
        "PASSWORD"
      ], 
      "required": true, 
      "title": "Authentication scheme name", 
      "type": "string"
    }, 
    "username": {
      "pattern": "^([a-zA-Z][a-zA-Z0-9-.]*[a-zA-Z]\\\\\\){0,1}\\w[\\w.-]+$", 
      "required": true, 
      "title": "User name to authenticate with", 
      "type": "string"
    }
  }, 
  "title": "Remote server authentication details", 
  "type": "object"
}

FileTransferProtocol (type)

{
  "additionalProperties": false, 
  "id": "FileTransferProtocol", 
  "module_id": "BackupConfiguration", 
  "properties": {
    "authentication_scheme": {
      "$ref": "FileTransferAuthenticationScheme, 
      "required": true, 
      "title": "Scheme to authenticate if required"
    }, 
    "protocol_name": {
      "default": "sftp", 
      "enum": [
        "sftp"
      ], 
      "required": true, 
      "title": "Protocol name", 
      "type": "string"
    }, 
    "ssh_fingerprint": {
      "description": "The expected SSH fingerprint of the server. If the server's fingerprint does not match this fingerprint, the connection will be terminated.  Only ECDSA fingerprints hashed with SHA256 are supported. To obtain the host's ssh fingerprint, you should connect via some method other than SSH to obtain this information. You can use one of these commands to view the key's fingerprint: 1. ssh-keygen -l -E sha256 -f ssh_host_ecdsa_key.pub 2. awk '{print $2}' ssh_host_ecdsa_key.pub | base64 -d | sha256sum -b |    sed 's/ .*$//' | xxd -r -p | base64 | sed 's/.//44g' |    awk '{print \"SHA256:\"$1}'", 
      "pattern": "^SHA256:.*$", 
      "required": true, 
      "title": "SSH fingerprint of server", 
      "type": "string", 
      "validation_msg_key": "com.vmware.nsx.validation.constraints.BackupRestore.fingerprint_pattern.message"
    }
  }, 
  "title": "Protocol to transfer backup file to remote server", 
  "type": "object"
}

FilterWidgetConfiguration (type)

{
  "additionalProperties": false, 
  "description": "Represents configuration for filter widget. This is abstract representation of filter widget.", 
  "extends": {
    "$ref": "WidgetConfiguration
  }, 
  "id": "FilterWidgetConfiguration", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "polymorphic-type-descriptor": {
    "type-identifier": "FilterWidgetConfiguration"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "alias": {
      "description": "Alias to be used when emitting filter value.", 
      "title": "Alias to be used when emitting filter value", 
      "type": "string"
    }, 
    "datasources": {
      "description": "The 'datasources' represent the sources from which data will be fetched. Currently, only NSX-API is supported as a 'default' datasource. An example of specifying 'default' datasource along with the urls to fetch data from is given at 'example_request' section of 'CreateWidgetConfiguration' API.", 
      "items": {
        "$ref": "Datasource
      }, 
      "minItems": 0, 
      "title": "Array of Datasource Instances with their relative urls", 
      "type": "array"
    }, 
    "default_filter_value": {
      "description": "Default filter values to be passed to datasources. This will be used when the report is requested without filter values.", 
      "items": {
        "$ref": "DefaultFilterValue
      }, 
      "title": "Default filter value to be passed to datasources", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "description": "Title of the widget. If display_name is omitted, the widget will be shown without a title.", 
      "maxLength": 255, 
      "title": "Widget Title", 
      "type": "string"
    }, 
    "drilldown_id": {
      "description": "Id of drilldown widget, if any. Id should be a valid id of an existing widget. A widget is considered as drilldown widget when it is associated with any other widget and provides more detailed information about any data item from the parent widget.", 
      "maxLength": 255, 
      "title": "Id of drilldown widget", 
      "type": "string"
    }, 
    "feature_set": {
      "$ref": "FeatureSet, 
      "description": "Features required to view the widget.", 
      "title": "Features required to view the widget"
    }, 
    "filter": {
      "description": "Id of filter widget for subscription, if any. Id should be a valid id of an existing filter widget. Filter widget should be from the same view. Datasource URLs should have placeholder values equal to filter alias to accept the filter value on filter change.", 
      "title": "Id of filter widget for subscription", 
      "type": "string"
    }, 
    "filter_value_required": {
      "default": true, 
      "description": "Flag to indicate that widget will continue to work without filter value. If this flag is set to false then default_filter_value is manadatory.", 
      "title": "Flag to indicate if filter value is necessary", 
      "type": "boolean"
    }, 
    "footer": {
      "$ref": "Footer
    }, 
    "icons": {
      "description": "Icons to be applied at dashboard for widgets and UI elements.", 
      "items": {
        "$ref": "Icon
      }, 
      "title": "Icons", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "is_drilldown": {
      "default": false, 
      "description": "Set to true if this widget should be used as a drilldown.", 
      "title": "Set as a drilldown widget", 
      "type": "boolean"
    }, 
    "legend": {
      "$ref": "Legend, 
      "description": "Legend to be displayed. If legend is not needed, do not include it.", 
      "title": "Legend for the widget"
    }, 
    "resource_type": {
      "description": "Supported visualization types are LabelValueConfiguration, DonutConfiguration, GridConfiguration, StatsConfiguration, MultiWidgetConfiguration, GraphConfiguration, ContainerConfiguration, CustomWidgetConfiguration and DropdownFilterWidgetConfiguration.", 
      "enum": [
        "LabelValueConfiguration", 
        "DonutConfiguration", 
        "MultiWidgetConfiguration", 
        "ContainerConfiguration", 
        "StatsConfiguration", 
        "GridConfiguration", 
        "GraphConfiguration", 
        "CustomWidgetConfiguration", 
        "DropdownFilterWidgetConfiguration"
      ], 
      "maxLength": 255, 
      "readonly": true, 
      "required": true, 
      "title": "Widget visualization type", 
      "type": "string"
    }, 
    "shared": {
      "deprecated": true, 
      "description": "Please use the property 'shared' of View instead of this. The widgets of a shared view are visible to other users.", 
      "title": "Visiblity of widgets to other users", 
      "type": "boolean"
    }, 
    "span": {
      "description": "Represents the horizontal span of the widget / container.", 
      "maximum": 12, 
      "minimum": 1, 
      "title": "Horizontal span", 
      "type": "int"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "weight": {
      "deprecated": true, 
      "description": "Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details.", 
      "title": "Weightage or placement of the widget or container", 
      "type": "int"
    }
  }, 
  "title": "Filter widget Configuration", 
  "type": "object"
}

FirewallConfiguration (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "FirewallConfiguration", 
  "module_id": "Policy", 
  "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: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "disable_auto_drafts": {
      "default": false, 
      "description": "To disable auto drafts, set it to true. By default, auto drafts are enabled.", 
      "title": "Auto draft 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"
    }, 
    "enable_firewall": {
      "default": true, 
      "description": "If set to true, Firewall is enabled.", 
      "title": "Firewall enable flag", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": [
        "DfwFirewallConfiguration"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Firewall related configurations", 
  "type": "object"
}

FloodProtectionProfile (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "description": "A profile holding TCP, UDP and ICMP and other protcol connection limits.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "FloodProtectionProfile", 
  "module_id": "PolicyProfile", 
  "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: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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"
    }, 
    "icmp_active_flow_limit": {
      "description": "If this field is empty, firewall will not set a limit to active ICMP connections.", 
      "maximum": 1000000, 
      "minimum": 1, 
      "title": "Active ICMP connections limit", 
      "type": "integer"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "other_active_conn_limit": {
      "description": "If this field is empty, firewall will not set a limit to other active connections. besides UDP, ICMP and half open TCP connections.", 
      "maximum": 1000000, 
      "minimum": 1, 
      "title": "Timeout after first TN", 
      "type": "integer"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": {
      "$ref": "FloodProtectionProfileResourceType, 
      "required": true
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "tcp_half_open_conn_limit": {
      "description": "If this field is empty, firewall will not set a limit to half open TCP connections.", 
      "maximum": 1000000, 
      "minimum": 1, 
      "title": "Active half open TCP connections limit", 
      "type": "integer"
    }, 
    "udp_active_flow_limit": {
      "description": "If this field is empty, firewall will not set a limit to active UDP connections.", 
      "maximum": 1000000, 
      "minimum": 1, 
      "title": "Active UDP connections limit", 
      "type": "integer"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Flood Protection profile", 
  "type": "object"
}

FloodProtectionProfileBindingListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "FloodProtectionProfileBindingListResult", 
  "module_id": "PolicyProfile", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "FloodProtectionProfileBindingMap
      }, 
      "required": true, 
      "title": "Flood protection profile binding maps list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of flood protection profile binding maps", 
  "type": "object"
}

FloodProtectionProfileBindingMap (type)

{
  "additionalProperties": false, 
  "description": "This entity will be used to establish association between Flood Protection profile and Logical Routers.", 
  "extends": {
    "$ref": "ProfileBindingMap
  }, 
  "id": "FloodProtectionProfileBindingMap", 
  "module_id": "PolicyProfile", 
  "polymorphic-type-descriptor": {
    "type-identifier": "FloodProtectionProfileBindingMap"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "profile_path": {
      "description": "PolicyPath of associated Profile", 
      "required": true, 
      "title": "Profile Path", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Policy Flood Protection Profile binding map", 
  "type": "object"
}

FloodProtectionProfileListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "FloodProtectionProfileListRequestParameters", 
  "module_id": "PolicyProfile", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Flood Protection profile list request parameters", 
  "type": "object"
}

FloodProtectionProfileListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "FloodProtectionProfileListResult", 
  "module_id": "PolicyProfile", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "FloodProtectionProfile
      }, 
      "required": true, 
      "title": "Flood protection profile list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of flood protection profiles", 
  "type": "object"
}

FloodProtectionProfileResourceType (type)

{
  "additionalProperties": false, 
  "description": "GatewayFloodProtectionProfile is used for all Tier0 and Tier1 gateways. DistributedFloodProtectionProfile is used for all Transport Nodes.", 
  "enum": [
    "GatewayFloodProtectionProfile", 
    "DistributedFloodProtectionProfile"
  ], 
  "id": "FloodProtectionProfileResourceType", 
  "module_id": "PolicyProfile", 
  "title": "Resource types of flood protection profiles", 
  "type": "string"
}

Footer (type)

{
  "additionalProperties": false, 
  "description": "Footer of a widget that provides additional information or allows an action such as clickable url for navigation. An example usage of footer is provided under 'example_request' section of 'CreateWidgetConfiguration' API.", 
  "id": "Footer", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "properties": {
    "actions": {
      "description": "Action to be performed at the footer of a widget. An action at the footer can be simple text description or a hyperlink to a UI page. Action allows a clickable url for navigation. An example usage of footer action is provided under 'example_request' section of 'CreateWidgetConfiguration' API.", 
      "items": {
        "$ref": "FooterAction
      }, 
      "minItems": 0, 
      "title": "Footer Actions", 
      "type": "array"
    }, 
    "condition": {
      "description": "If the condition is met then the footer will be applied. Examples of expression syntax are provided under 'example_request' section of 'CreateWidgetConfiguration' API.", 
      "maxLength": 1024, 
      "title": "Expression for evaluating condition", 
      "type": "string"
    }
  }, 
  "title": "Widget Footer", 
  "type": "object"
}

FooterAction (type)

{
  "additionalProperties": false, 
  "description": "Action specified at the footer of a widget to provide additional information or to provide a clickable url for navigation. An example usage of footer action is provided under the 'example_request' section of 'CreateWidgetConfiguration' API.", 
  "id": "FooterAction", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "properties": {
    "dock_to_container_footer": {
      "default": true, 
      "description": "If true, the footer will appear in the underlying container that holds the widget.", 
      "title": "Dock the footer at container", 
      "type": "boolean"
    }, 
    "label": {
      "$ref": "Label, 
      "description": "Label to be displayed against the footer action.", 
      "required": true, 
      "title": "Label for action"
    }, 
    "url": {
      "description": "Hyperlink to the UI page that provides details of action.", 
      "maxLength": 1024, 
      "title": "Clickable hyperlink, if any", 
      "type": "string"
    }
  }, 
  "title": "Widget Footer Action", 
  "type": "object"
}

ForceRevisionCheckRequestParameter (type)

{
  "description": "Forces revision check before updating", 
  "id": "ForceRevisionCheckRequestParameter", 
  "module_id": "Policy", 
  "properties": {
    "enforce_revision_check": {
      "default": false, 
      "description": "If this is set to true, each child object in the request needs to have _revision property set correctly. System will honor the revision numbers while updating the resources.", 
      "readonly": false, 
      "required": false, 
      "title": "Force revision check", 
      "type": "boolean"
    }
  }, 
  "title": "Parameter to enforce revision check before updating objects", 
  "type": "object"
}

ForwardingPolicy (type)

{
  "additionalProperties": false, 
  "description": "Contains ordered list of forwarding rules that determine when to forward traffic to / from the underlay for accessing cloud native services.", 
  "extends": {
    "$ref": "Policy
  }, 
  "id": "ForwardingPolicy", 
  "module_id": "PolicyForwarding", 
  "policy_hierarchical_children": [
    "ChildForwardingRule"
  ], 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "category": {
      "description": "- Distributed Firewall - Policy framework provides five pre-defined categories for classifying a security policy. They are \"Ethernet\",\"Emergency\", \"Infrastructure\" \"Environment\" and \"Application\". There is a pre-determined order in which the policy framework manages the priority of these security policies. Ethernet category is for supporting layer 2 firewall rules. The other four categories are applicable for layer 3 rules. Amongst them, the Emergency category has the highest priority followed by Infrastructure, Environment and then Application rules. Administrator can choose to categorize a security policy into the above categories or can choose to leave it empty. If empty it will have the least precedence w.r.t the above four categories. - Edge Firewall - Policy Framework for Edge Firewall provides six pre-defined categories \"Emergency\", \"SystemRules\", \"SharedPreRules\", \"LocalGatewayRules\", \"AutoServiceRules\" and \"Default\", in order of priority of rules. All categories are allowed for Gatetway Policies that belong to 'default' Domain. However, for user created domains, category is restricted to \"SharedPreRules\" or \"LocalGatewayRules\" only. Also, the users can add/modify/delete rules from only the \"SharedPreRules\" and \"LocalGatewayRules\" categories. If user doesn't specify the category then defaulted to \"Rules\". System generated category is used by NSX created rules, for example BFD rules. Autoplumbed category used by NSX verticals to autoplumb data path rules. Finally, \"Default\" category is the placeholder default rules with lowest in the order of priority.", 
      "required": false, 
      "title": "A way to classify a security policy, if needed.", 
      "type": "string"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "comments": {
      "description": "Comments for security policy lock/unlock.", 
      "readonly": false, 
      "required": false, 
      "title": "SecurityPolicy lock/unlock comments", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "internal_sequence_number": {
      "description": "This field is to indicate the internal sequence number of a policy with respect to the policies across categories.", 
      "readonly": true, 
      "title": "Internal sequence number", 
      "type": "int"
    }, 
    "is_default": {
      "description": "A flag to indicate whether policy is a default policy.", 
      "readonly": true, 
      "required": false, 
      "title": "Default policy flag", 
      "type": "boolean"
    }, 
    "lock_modified_by": {
      "description": "ID of the user who last modified the lock for the secruity policy.", 
      "readonly": true, 
      "required": false, 
      "title": "User who locked the security policy", 
      "type": "string"
    }, 
    "lock_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "description": "SecurityPolicy locked/unlocked time in epoch milliseconds.", 
      "readonly": true, 
      "required": false, 
      "title": "SecuirtyPolicy locked/unlocked time"
    }, 
    "locked": {
      "default": false, 
      "description": "Indicates whether a security policy should be locked. If the security policy is locked by a user, then no other user would be able to modify this security policy. Once the user releases the lock, other users can update this security policy.", 
      "required": false, 
      "title": "Lock a security policy", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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"
    }, 
    "rule_count": {
      "description": "The count of rules in the policy.", 
      "readonly": true, 
      "title": "Rule count", 
      "type": "int"
    }, 
    "rules": {
      "items": {
        "$ref": "ForwardingRule
      }, 
      "required": false, 
      "title": "Rules that are a part of this ForwardingPolicy", 
      "type": "array"
    }, 
    "scheduler_path": {
      "description": "Provides a mechanism to apply the rules in this policy for a specified time duration.", 
      "readonly": false, 
      "required": false, 
      "title": "Path to the scheduler for time based scheduling", 
      "type": "string"
    }, 
    "scope": {
      "description": "The list of group paths where the rules in this policy will get applied. This scope will take precedence over rule level scope. Supported only for security and redirection policies. In case of RedirectionPolicy, it is expected only when the policy is NS and redirecting to service chain.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 128, 
      "required": false, 
      "type": "array"
    }, 
    "sequence_number": {
      "description": "This field is used to resolve conflicts between security policies across domains. In order to change the sequence number of a policy one can fire a POST request on the policy entity with a query parameter action=revise The sequence number field will reflect the value of the computed sequence number upon execution of the above mentioned POST request. For scenarios where the administrator is using a template to update several security policies, the only way to set the sequence number is to explicitly specify the sequence number for each security policy. If no sequence number is specified in the payload, a value of 0 is assigned by default. If there are multiple policies with the same sequence number then their order is not deterministic. If a specific order of policies is desired, then one has to specify unique sequence numbers or use the POST request on the policy entity with a query parameter action=revise to let the framework assign a sequence number", 
      "minimum": 0, 
      "title": "Sequence number to resolve conflicts across Domains", 
      "type": "int"
    }, 
    "stateful": {
      "description": "Stateful or Stateless nature of security policy is enforced on all rules in this security policy. When it is stateful, the state of the network connects are tracked and a stateful packet inspection is performed. Layer3 security policies can be stateful or stateless. By default, they are stateful. Layer2 security policies can only be stateless.", 
      "readonly": false, 
      "required": false, 
      "title": "Stateful nature of the entries within this security policy.", 
      "type": "boolean"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "tcp_strict": {
      "description": "Ensures that a 3 way TCP handshake is done before the data packets are sent. tcp_strict=true is supported only for stateful security policies. If the tcp_strict flag is not specified and the security policy is stateful, then tcp_strict will be set to true.", 
      "readonly": false, 
      "required": false, 
      "title": "Enforce strict tcp handshake before allowing data packets", 
      "type": "boolean"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Forwarding Policy\n", 
  "type": "object"
}

ForwardingPolicyListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyListResult
  }, 
  "id": "ForwardingPolicyListResult", 
  "module_id": "PolicyForwarding", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "ForwardingPolicy
      }, 
      "required": true, 
      "title": "ForwardingPolicy list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of ForwardingPolicy objects", 
  "type": "object"
}

ForwardingRule (type)

{
  "additionalProperties": false, 
  "description": "Forwarding rule that determine how to forward traffic from a VM. Traffic from VM can either be routed via Overlay or Underlay when VM is on hybrid port. Additionally NAT can be performed for VM or container on overlay to route traffic to/from underlay ROUTE_TO_UNDERLAY - Access a service on underlay space from a VM connected to hybrid port. Eg access to AWS S3 on AWS underlay ROUTE_TO_OVERLAY -  Access a service on overlay space from a VM connected to hybrid port. ROUTE_FROM_UNDERLAY - Access a service hosted on a VM (that is connected to hybrid port) from underlay space. Eg access from AWS ELB to VM ROUTE_FROM_OVERLAY - Access a  service hosted on a VM (that is connected to hybrid port) from overlay space NAT_FROM_UNDERLAY - Access a service on overlay VM/container from underlay space using DNAT from underlay IP to overlay IP NAT_TO_UNDERLAY - Access an underlay service from a VM/container on overlay space using SNAT from overlay IP to underlay IP", 
  "extends": {
    "$ref": "BaseRule
  }, 
  "id": "ForwardingRule", 
  "module_id": "PolicyForwarding", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "action": {
      "description": "The action to be applied to all the services", 
      "enum": [
        "ROUTE_TO_UNDERLAY", 
        "ROUTE_TO_OVERLAY", 
        "ROUTE_FROM_UNDERLAY", 
        "ROUTE_FROM_OVERLAY", 
        "NAT_FROM_UNDERLAY", 
        "NAT_TO_UNDERLAY"
      ], 
      "required": false, 
      "title": "Action", 
      "type": "string"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "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 domains. Along with paths we support IP Address of type IPv4 and IPv6. IP Address can be in one of the format(CIDR, IP Address, Range of IP Address). 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.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 128, 
      "required": false, 
      "title": "Destination group paths", 
      "type": "array"
    }, 
    "destinations_excluded": {
      "default": false, 
      "description": "If set to true, the rule gets applied on all the groups that are NOT part of the destination groups. If false, the rule applies to the destination groups", 
      "readonly": false, 
      "required": false, 
      "title": "Negation of destination groups", 
      "type": "boolean"
    }, 
    "direction": {
      "default": "IN_OUT", 
      "description": "Define direction of traffic.", 
      "enum": [
        "IN", 
        "OUT", 
        "IN_OUT"
      ], 
      "required": false, 
      "title": "Direction", 
      "type": "string"
    }, 
    "disabled": {
      "default": false, 
      "description": "Flag to disable the rule. Default is enabled.", 
      "readonly": false, 
      "required": false, 
      "title": "Flag to disable the rule", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ip_protocol": {
      "description": "Type of IP packet that should be matched while enforcing the rule. The value is set to IPV4_IPV6 for Layer3 rule if not specified. For Layer2/Ether rule the value must be null.", 
      "enum": [
        "IPV4", 
        "IPV6", 
        "IPV4_IPV6"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "IPv4 vs IPv6 packet type", 
      "type": "string"
    }, 
    "is_default": {
      "description": "A flag to indicate whether rule is a default rule.", 
      "readonly": true, 
      "required": false, 
      "title": "Default rule flag", 
      "type": "boolean"
    }, 
    "logged": {
      "default": false, 
      "description": "Flag to enable packet logging. Default is disabled.", 
      "readonly": false, 
      "required": false, 
      "title": "Enable logging flag", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "notes": {
      "description": "Text for additional notes on changes.", 
      "maxLength": 2048, 
      "readonly": false, 
      "required": false, 
      "title": "Text for additional notes on changes", 
      "type": "string"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "profiles": {
      "description": "Holds the list of layer 7 service profile paths. These profiles accept attributes and sub-attributes of various network services (e.g. L4 AppId, encryption algorithm, domain name, etc) as key value pairs.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 128, 
      "required": false, 
      "title": "Layer 7 service profiles", 
      "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"
    }, 
    "rule_id": {
      "description": "This is a unique 4 byte positive number that is assigned by the system.  This rule id is passed all the way down to the data path. The first 1GB (1000 to 2^30) will be shared by GM and LM with zebra style striped number space. For E.g 1000 to (1Million -1) by LM, (1M - 2M-1) by GM and so on.", 
      "readonly": true, 
      "required": false, 
      "title": "Unique rule ID", 
      "type": "integer"
    }, 
    "scope": {
      "description": "The list of policy paths where the rule is applied LR/Edge/T0/T1/LRP etc. Note that a given rule can be applied on multiple LRs/LRPs.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 128, 
      "required": false, 
      "type": "array"
    }, 
    "sequence_number": {
      "description": "This field is used to resolve conflicts between multiple Rules under Security or Gateway Policy for a Domain If no sequence number is specified in the payload, a value of 0 is assigned by default. If there are multiple rules with the same sequence number then their order is not deterministic. If a specific order of rules is desired, then one has to specify unique sequence numbers or use the POST request on the rule entity with a query parameter action=revise to let the framework assign a sequence number", 
      "minimum": 0, 
      "required": false, 
      "title": "Sequence number of the this Rule", 
      "type": "int"
    }, 
    "service_entries": {
      "description": "In order to specify raw services this can be used, along with services which contains path to services. This can be empty or null.", 
      "items": {
        "$ref": "ServiceEntry
      }, 
      "maxItems": 128, 
      "required": false, 
      "title": "Raw services", 
      "type": "array"
    }, 
    "services": {
      "description": "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.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 128, 
      "required": false, 
      "title": "Names of services", 
      "type": "array"
    }, 
    "source_groups": {
      "description": "We need paths as duplicate names may exist for groups under different domains. Along with paths we support IP Address of type IPv4 and IPv6. IP Address can be in one of the format(CIDR, IP Address, Range of IP Address). 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.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 128, 
      "required": false, 
      "title": "Source group paths", 
      "type": "array"
    }, 
    "sources_excluded": {
      "default": false, 
      "description": "If set to true, the rule gets applied on all the groups that are NOT part of the source groups. If false, the rule applies to the source groups", 
      "readonly": false, 
      "required": false, 
      "title": "Negation of source groups", 
      "type": "boolean"
    }, 
    "tag": {
      "description": "User level field which will be printed in CLI and packet logs.", 
      "required": false, 
      "title": "Tag applied on the rule", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Forwarding rule", 
  "type": "object"
}

ForwardingRuleListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "RuleListRequestParameters
  }, 
  "id": "ForwardingRuleListRequestParameters", 
  "module_id": "PolicyForwarding", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "ForwardingRule list request parameters", 
  "type": "object"
}

ForwardingRuleListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "BaseRuleListResult
  }, 
  "id": "ForwardingRuleListResult", 
  "module_id": "PolicyForwarding", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "ForwardingRule
      }, 
      "required": true, 
      "title": "Rule list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of ForwardingRules", 
  "type": "object"
}

FqdnAnalysisConfig (type)

{
  "additionalProperties": false, 
  "description": "The type contains information about the configuration of the FqdnAnalysis feature for a specific node.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "FqdnAnalysisConfig", 
  "module_id": "PolicyUrlCategorization", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "enabled": {
      "default": false, 
      "description": "Property which specifies the enabling/disabling of the feature.", 
      "required": false, 
      "title": "Enabled", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "FQDN Analysis feature configuration entity", 
  "type": "object"
}

FullSyncState (type)

{
  "additionalProperties": false, 
  "description": "Provides FullSync state for Local Manager from Global Manager.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "FullSyncState", 
  "module_id": "PolicyFullSync", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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"
    }, 
    "errors": {
      "description": "Errors occurred during full sync.", 
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "title": "Errors occurred during full sync", 
      "type": "array"
    }, 
    "full_sync_id": {
      "description": "Full sync id generated by Async Replicator (AR) service.", 
      "readonly": true, 
      "title": "Full sync id", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "last_completed_stage": {
      "description": "The current stage of full sync completion for ongoing sync. When Local Manager (LM) receives full sync data from AR, LM starts with workflow to prserve the state and restore the full sync from where it has left off in case of change of leadership of the service to different NSX node or LM is restarted. LM starts the full sync workflow with state INITIAL capturing the AR full sync id and data location details. The stage/state transition follows the order given below INITIAL - Full sync started PROCESSED_FULLSYNC_DATA - Compelted processing the full state data                           provided by AR PRCESSED_DELTAS - Completed processing pending delta changes provided                   by AR. DELETED_STALE_ENTITIES - Completed deletion of all global entities on                          LM that are not in GM anymore COMPLETED - Full sync handling is completed on LM ERROR - Full sync failed with errors on LM, in which case AR will         re-attempt full sync later point in time for the LM ABORTED - Indicates that the full sync cancelled as per user request", 
      "enum": [
        "INITIAL", 
        "PAUSE_DCNS", 
        "DELETED_STALE_ENTITIES", 
        "PROCESSED_FULLSYNC_DATA", 
        "PROCESSED_DELTAS", 
        "UNPAUSE_DCNS", 
        "COMPLETED", 
        "ERROR", 
        "ABORTED"
      ], 
      "readonly": true, 
      "title": "Full sync stage that is last completed for this request.", 
      "type": "string"
    }, 
    "last_upate_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last update, could be progress or success or error.", 
      "readonly": true
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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"
    }, 
    "start_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of Full Sync start.", 
      "readonly": true
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Full sync state", 
  "type": "object"
}

FullSyncStateListResult (type)

{
  "additionalProperties": false, 
  "description": "Paged Collection of FullSync states.", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "FullSyncStateListResult", 
  "module_id": "PolicyFullSync", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "FullSync states list.", 
      "items": {
        "$ref": "FullSyncState
      }, 
      "required": true, 
      "title": "FullSync states list", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of FullSync states.", 
  "type": "object"
}

GatewayFloodProtectionProfile (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "FloodProtectionProfile
  }, 
  "id": "GatewayFloodProtectionProfile", 
  "module_id": "PolicyProfile", 
  "polymorphic-type-descriptor": {
    "type-identifier": "GatewayFloodProtectionProfile"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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"
    }, 
    "icmp_active_flow_limit": {
      "description": "If this field is empty, firewall will not set a limit to active ICMP connections.", 
      "maximum": 1000000, 
      "minimum": 1, 
      "title": "Active ICMP connections limit", 
      "type": "integer"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "nat_active_conn_limit": {
      "default": 4294967295, 
      "description": "The maximum limit of active NAT connections. This limit only apply to EDGE components (such as, gateway). If this property is omitted, or set to null, then there is no limit on the specific component. Meanwhile there is an implicit limit which depends on the underlying hardware resource.", 
      "maximum": 4294967295, 
      "minimum": 1, 
      "readonly": false, 
      "title": "Maximum limit of active NAT connections", 
      "type": "integer"
    }, 
    "other_active_conn_limit": {
      "description": "If this field is empty, firewall will not set a limit to other active connections. besides UDP, ICMP and half open TCP connections.", 
      "maximum": 1000000, 
      "minimum": 1, 
      "title": "Timeout after first TN", 
      "type": "integer"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": {
      "$ref": "FloodProtectionProfileResourceType, 
      "required": true
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "tcp_half_open_conn_limit": {
      "description": "If this field is empty, firewall will not set a limit to half open TCP connections.", 
      "maximum": 1000000, 
      "minimum": 1, 
      "title": "Active half open TCP connections limit", 
      "type": "integer"
    }, 
    "udp_active_flow_limit": {
      "description": "If this field is empty, firewall will not set a limit to active UDP connections.", 
      "maximum": 1000000, 
      "minimum": 1, 
      "title": "Active UDP connections limit", 
      "type": "integer"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "type": "object"
}

GatewayGeneralSecurityProfile (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "GeneralSecurityProfile
  }, 
  "id": "GatewayGeneralSecurityProfile", 
  "module_id": "PolicyProfile", 
  "polymorphic-type-descriptor": {
    "type-identifier": "GatewayGeneralSecurityProfile"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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"
    }, 
    "enable_double_flow": {
      "default": false, 
      "description": "The flag to indicate double flow check is enabled or not. This option applies only to EDGE components.", 
      "readonly": false, 
      "title": "Flag to indicate double flow check is enabled or not", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": {
      "$ref": "GeneralSecurityProfileResourceType, 
      "required": true
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "type": "object"
}

GatewayPolicy (type)

{
  "extends": {
    "$ref": "Policy
  }, 
  "id": "GatewayPolicy", 
  "module_id": "Policy", 
  "policy_hierarchical_children": [
    "ChildRule"
  ], 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "category": {
      "description": "- Distributed Firewall - Policy framework provides five pre-defined categories for classifying a security policy. They are \"Ethernet\",\"Emergency\", \"Infrastructure\" \"Environment\" and \"Application\". There is a pre-determined order in which the policy framework manages the priority of these security policies. Ethernet category is for supporting layer 2 firewall rules. The other four categories are applicable for layer 3 rules. Amongst them, the Emergency category has the highest priority followed by Infrastructure, Environment and then Application rules. Administrator can choose to categorize a security policy into the above categories or can choose to leave it empty. If empty it will have the least precedence w.r.t the above four categories. - Edge Firewall - Policy Framework for Edge Firewall provides six pre-defined categories \"Emergency\", \"SystemRules\", \"SharedPreRules\", \"LocalGatewayRules\", \"AutoServiceRules\" and \"Default\", in order of priority of rules. All categories are allowed for Gatetway Policies that belong to 'default' Domain. However, for user created domains, category is restricted to \"SharedPreRules\" or \"LocalGatewayRules\" only. Also, the users can add/modify/delete rules from only the \"SharedPreRules\" and \"LocalGatewayRules\" categories. If user doesn't specify the category then defaulted to \"Rules\". System generated category is used by NSX created rules, for example BFD rules. Autoplumbed category used by NSX verticals to autoplumb data path rules. Finally, \"Default\" category is the placeholder default rules with lowest in the order of priority.", 
      "required": false, 
      "title": "A way to classify a security policy, if needed.", 
      "type": "string"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "comments": {
      "description": "Comments for security policy lock/unlock.", 
      "readonly": false, 
      "required": false, 
      "title": "SecurityPolicy lock/unlock comments", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "internal_sequence_number": {
      "description": "This field is to indicate the internal sequence number of a policy with respect to the policies across categories.", 
      "readonly": true, 
      "title": "Internal sequence number", 
      "type": "int"
    }, 
    "is_default": {
      "description": "A flag to indicate whether policy is a default policy.", 
      "readonly": true, 
      "required": false, 
      "title": "Default policy flag", 
      "type": "boolean"
    }, 
    "lock_modified_by": {
      "description": "ID of the user who last modified the lock for the secruity policy.", 
      "readonly": true, 
      "required": false, 
      "title": "User who locked the security policy", 
      "type": "string"
    }, 
    "lock_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "description": "SecurityPolicy locked/unlocked time in epoch milliseconds.", 
      "readonly": true, 
      "required": false, 
      "title": "SecuirtyPolicy locked/unlocked time"
    }, 
    "locked": {
      "default": false, 
      "description": "Indicates whether a security policy should be locked. If the security policy is locked by a user, then no other user would be able to modify this security policy. Once the user releases the lock, other users can update this security policy.", 
      "required": false, 
      "title": "Lock a security policy", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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"
    }, 
    "rule_count": {
      "description": "The count of rules in the policy.", 
      "readonly": true, 
      "title": "Rule count", 
      "type": "int"
    }, 
    "rules": {
      "items": {
        "$ref": "Rule
      }, 
      "required": false, 
      "title": "Rules that are a part of this SecurityPolicy", 
      "type": "array"
    }, 
    "scheduler_path": {
      "description": "Provides a mechanism to apply the rules in this policy for a specified time duration.", 
      "readonly": false, 
      "required": false, 
      "title": "Path to the scheduler for time based scheduling", 
      "type": "string"
    }, 
    "scope": {
      "description": "The list of group paths where the rules in this policy will get applied. This scope will take precedence over rule level scope. Supported only for security and redirection policies. In case of RedirectionPolicy, it is expected only when the policy is NS and redirecting to service chain.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 128, 
      "required": false, 
      "type": "array"
    }, 
    "sequence_number": {
      "description": "This field is used to resolve conflicts between security policies across domains. In order to change the sequence number of a policy one can fire a POST request on the policy entity with a query parameter action=revise The sequence number field will reflect the value of the computed sequence number upon execution of the above mentioned POST request. For scenarios where the administrator is using a template to update several security policies, the only way to set the sequence number is to explicitly specify the sequence number for each security policy. If no sequence number is specified in the payload, a value of 0 is assigned by default. If there are multiple policies with the same sequence number then their order is not deterministic. If a specific order of policies is desired, then one has to specify unique sequence numbers or use the POST request on the policy entity with a query parameter action=revise to let the framework assign a sequence number", 
      "minimum": 0, 
      "title": "Sequence number to resolve conflicts across Domains", 
      "type": "int"
    }, 
    "stateful": {
      "description": "Stateful or Stateless nature of security policy is enforced on all rules in this security policy. When it is stateful, the state of the network connects are tracked and a stateful packet inspection is performed. Layer3 security policies can be stateful or stateless. By default, they are stateful. Layer2 security policies can only be stateless.", 
      "readonly": false, 
      "required": false, 
      "title": "Stateful nature of the entries within this security policy.", 
      "type": "boolean"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "tcp_strict": {
      "description": "Ensures that a 3 way TCP handshake is done before the data packets are sent. tcp_strict=true is supported only for stateful security policies. If the tcp_strict flag is not specified and the security policy is stateful, then tcp_strict will be set to true.", 
      "readonly": false, 
      "required": false, 
      "title": "Enforce strict tcp handshake before allowing data packets", 
      "type": "boolean"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Contains ordered list of Rules for GatewayPolicy", 
  "type": "object"
}

GatewayPolicyListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyListResult
  }, 
  "id": "GatewayPolicyListResult", 
  "module_id": "Policy", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "GatewayPolicy
      }, 
      "required": true, 
      "title": "GatewayPolicy list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of gateway policies", 
  "type": "object"
}

GatewayQosProfile (type)

{
  "additionalProperties": false, 
  "description": "QoS profile contains configuration of rate limiting properties which can be applied in ingress and egress directions at Tier1 gateways", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "GatewayQosProfile", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "burst_size": {
      "default": 1, 
      "description": "Burst size in bytes.", 
      "minimum": 1, 
      "title": "Burst size in bytes", 
      "type": "int"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "committed_bandwitdth": {
      "default": 1, 
      "description": "Committed bandwidth in both directions specoficd in Mbps. Bandwidth is limited to line rate when the value configured is greater than line rate.", 
      "minimum": 1, 
      "title": "Committed bandwidth in Mbps", 
      "type": "int"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "excess_action": {
      "description": "Action on traffic exceeding bandwidth.", 
      "enum": [
        "DROP"
      ], 
      "required": false, 
      "title": "Action on traffic exceeding bandwidth.", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "QoS configuration of Tier1 gateway", 
  "type": "object"
}

GatewayQosProfileConfig (type)

{
  "additionalProperties": false, 
  "id": "GatewayQosProfileConfig", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "egress_qos_profile_path": {
      "description": "Policy path to gateway QoS profile in egress direction.", 
      "required": false, 
      "title": "Egress QoS profile", 
      "type": "string"
    }, 
    "ingress_qos_profile_path": {
      "description": "Policy path to gateway QoS profile in ingress direction.", 
      "required": false, 
      "title": "Ingress QoS profile", 
      "type": "string"
    }
  }, 
  "title": "Gateway QoS profile configuration", 
  "type": "object"
}

GatewayQosProfileListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "GatewayQosProfileListResult", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "GatewayQosProfile
      }, 
      "required": true, 
      "title": "Paginated list of GatewayQosProfile", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

GatewayRouteCsvRecord (type)

{
  "extends": {
    "$ref": "CsvRecord
  }, 
  "id": "GatewayRouteCsvRecord", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "admin_distance": {
      "required": false, 
      "title": "The admin distance of the next hop", 
      "type": "integer"
    }, 
    "edge_path": {
      "description": "Edge node policy path.", 
      "readonly": true, 
      "title": "Edge path", 
      "type": "string"
    }, 
    "interface": {
      "required": false, 
      "title": "The policy path of the interface which is used as the next hop", 
      "type": "string"
    }, 
    "lr_component_id": {
      "required": false, 
      "title": "Logical router component(Service Router/Distributed Router) id", 
      "type": "string"
    }, 
    "lr_component_type": {
      "required": false, 
      "title": "Logical router component(Service Router/Distributed Router) type", 
      "type": "string"
    }, 
    "network": {
      "$ref": "IPCIDRBlock, 
      "required": true, 
      "title": "CIDR network address"
    }, 
    "next_hop": {
      "$ref": "IPAddress, 
      "required": false, 
      "title": "The IP of the next hop"
    }, 
    "route_type": {
      "required": true, 
      "title": "Route type (USER, CONNECTED, NSX_INTERNAL,..)", 
      "type": "string"
    }
  }, 
  "type": "object"
}

GatewayRouteTableInCsvFormat (type)

{
  "extends": {
    "$ref": "CsvListResult
  }, 
  "id": "GatewayRouteTableInCsvFormat", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "file_name": {
      "description": "File name set by HTTP server if API  returns CSV result as a file.", 
      "required": false, 
      "title": "File name", 
      "type": "string"
    }, 
    "last_update_timestamp": {
      "$ref": "EpochMsTimestamp, 
      "description": "Timestamp when the data was last updated; unset if data source has never updated the data.", 
      "readonly": true
    }, 
    "results": {
      "items": {
        "$ref": "GatewayRouteCsvRecord
      }, 
      "required": false, 
      "type": "array"
    }
  }, 
  "type": "object"
}

GeneralSecurityProfile (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "description": "A profile holding general security settings.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "GeneralSecurityProfile", 
  "module_id": "PolicyProfile", 
  "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: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": {
      "$ref": "GeneralSecurityProfileResourceType, 
      "required": true
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "General Security profile", 
  "type": "object"
}

GeneralSecurityProfileBindingMap (type)

{
  "additionalProperties": false, 
  "description": "This entity will be used to establish association between General Security profile and Logical Routers.", 
  "extends": {
    "$ref": "ProfileBindingMap
  }, 
  "id": "GeneralSecurityProfileBindingMap", 
  "module_id": "PolicyProfile", 
  "polymorphic-type-descriptor": {
    "type-identifier": "GeneralSecurityProfileBindingMap"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "profile_path": {
      "description": "PolicyPath of associated Profile", 
      "required": true, 
      "title": "Profile Path", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Policy General Security profile binding map", 
  "type": "object"
}

GeneralSecurityProfileResourceType (type)

{
  "additionalProperties": false, 
  "description": "GatewayGeneralSecurityProfile is used for all Tier0 and Tier1 gateways.", 
  "enum": [
    "GatewayGeneralSecurityProfile"
  ], 
  "id": "GeneralSecurityProfileResourceType", 
  "module_id": "PolicyProfile", 
  "title": "Resource types of General Security profiles", 
  "type": "string"
}

GenericDhcpOption (type)

{
  "additionalProperties": false, 
  "description": "Define DHCP options other than option 121.", 
  "id": "GenericDhcpOption", 
  "module_id": "Dhcp", 
  "properties": {
    "code": {
      "description": "Code of the dhcp option.", 
      "maximum": 255, 
      "minimum": 0, 
      "required": true, 
      "title": "DHCP option code, [0-255]", 
      "type": "integer"
    }, 
    "values": {
      "description": "Value of the option.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 10, 
      "minItems": 1, 
      "required": true, 
      "title": "DHCP option value", 
      "type": "array"
    }
  }, 
  "title": "Generic DHCP option", 
  "type": "object"
}

GenericPolicyRealizedResource (type)

{
  "description": "Represents realized entity", 
  "extends": {
    "$ref": "PolicyRealizedResource
  }, 
  "id": "GenericPolicyRealizedResource", 
  "module_id": "PolicyRealizedState", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "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_point_path": {
      "description": "The path of the enforcement point.", 
      "readonly": true, 
      "title": "Enforcement Point Path", 
      "type": "string"
    }, 
    "entity_type": {
      "readonly": true, 
      "title": "Type of realized entity", 
      "type": "string"
    }, 
    "extended_attributes": {
      "items": {
        "$ref": "AttributeVal
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Collection of type specific properties", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "intent_paths": {
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "title": "Collection of intent paths", 
      "type": "array"
    }, 
    "intent_reference": {
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Desire state paths of this object", 
      "type": "array"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "realization_api": {
      "required": false, 
      "title": "Realization API of this object on enforcement point", 
      "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"
    }, 
    "runtime_error": {
      "description": "It define the root cause for runtime error.", 
      "required": false, 
      "title": "String representation of runtime error", 
      "type": "string"
    }, 
    "runtime_status": {
      "description": "Possible values could be UP, DOWN, UNKNOWN, DEGRADED This list is not exhaustive.", 
      "required": false, 
      "title": "String representation of runtime status", 
      "type": "string"
    }, 
    "site_path": {
      "description": "The site where this entity resides.", 
      "readonly": true, 
      "title": "Site Path", 
      "type": "string"
    }, 
    "state": {
      "enum": [
        "UNAVAILABLE", 
        "UNREALIZED", 
        "REALIZED", 
        "ERROR"
      ], 
      "required": true, 
      "title": "Realization state of this object", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Generic realized entity", 
  "type": "object"
}

GenericPolicyRealizedResourceListResult (type)

{
  "additionalProperties": false, 
  "description": "GenericPolicyRealizedResource list result", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "GenericPolicyRealizedResourceListResult", 
  "module_id": "PolicyRealizedState", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "List of realized resources", 
      "items": {
        "$ref": "GenericPolicyRealizedResource
      }, 
      "required": false, 
      "title": "Paged Collection of GenericPolicyRealizedResources", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "GenericPolicyRealizedResource list result", 
  "type": "object"
}

GetBackupUiFramesInfoRequestParameters (type)

{
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "GetBackupUiFramesInfoRequestParameters", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "ui_tab_type": {
      "default": "LOCAL_MANAGER_TAB", 
      "enum": [
        "LOCAL_MANAGER_TAB", 
        "GLOBAL_MANAGER_TAB"
      ], 
      "readonly": true, 
      "required": false, 
      "type": "string"
    }
  }, 
  "type": "object"
}

GetCertParameter (type)

{
  "additionalProperties": false, 
  "id": "GetCertParameter", 
  "module_id": "CertificateManager", 
  "properties": {
    "details": {
      "default": false, 
      "required": false, 
      "title": "whether to expand the pem data and show all its details", 
      "type": "boolean"
    }
  }, 
  "type": "object"
}

GetSNMPParameters (type)

{
  "additionalProperties": false, 
  "description": "Get SNMP request parameters.", 
  "id": "GetSNMPParameters", 
  "properties": {
    "show_sensitive_data": {
      "default": false, 
      "description": "Whether to show SNMP service properties including community strings if any applicable.", 
      "required": false, 
      "title": "Show SNMP sensitive data or not", 
      "type": "boolean"
    }
  }, 
  "title": "Get SNMP request parameters", 
  "type": "object"
}

GlobalCollectorConfig (type)

{
  "abstract": true, 
  "description": "The GlobalCollectorConfig is the base class for global collector configurations for different types in a NSX domain.", 
  "id": "GlobalCollectorConfig", 
  "module_id": "Policy", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "collector_type"
  }, 
  "properties": {
    "collector_ip": {
      "$ref": "IPAddress, 
      "description": "IP address for the global collector.", 
      "required": true, 
      "title": "IP address for the global collector collector"
    }, 
    "collector_port": {
      "description": "Port for the global collector.", 
      "maximum": 65535, 
      "minimum": 0, 
      "required": true, 
      "title": "Port for the global collector", 
      "type": "int"
    }, 
    "collector_type": {
      "$ref": "GlobalCollectorType, 
      "description": "Specify the global collector type.", 
      "required": true
    }
  }, 
  "title": "Abstract base type for Global collector configurations of different types", 
  "type": "object"
}

GlobalCollectorType (type)

{
  "enum": [
    "VRNI", 
    "WAVE_FRONT"
  ], 
  "id": "GlobalCollectorType", 
  "module_id": "Policy", 
  "title": "Valid Global collector types", 
  "type": "string"
}

GlobalConfig (type)

{
  "additionalProperties": false, 
  "description": "Global configuration", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "GlobalConfig", 
  "module_id": "Policy", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "allow_changing_vdr_mac_in_use": {
      "default": false, 
      "description": "When this flag is set to true, it is allowed to change the VDR MAC being used by existing transport nodes in a NSX system. The VDR MAC used by a host switch in a transport node is decided by the OVERLAY transport zone(s) which the host switch joins. If any of the OVERLAY transport zone(s) has \"nested_nsx\" property set to true, the MAC in \"vdr_mac_nested\" is used; otherwise the MAC in \"vdr_mac\" is used. Thus the VDR MAC being used by a host switch in a transport node can be changed in below ways. If the host switch is not in any OVERLAY transport zone whose \"nested_nsx\" property is true but is in an OVERLAY transport zone, the first way is updating the \"vdr_mac\" property. The 2nd way is updating one of the OVERLAY tranport zones joined by the host switch to set \"nested_nsx\" property true which will make the host switch use the VDR MAC in \"vdr_mac_nested\". The third way is directly updating the transport node to add an OVERLAY transport zone whose \"nested_nsx\" property is true into the host switch which will also make the host switch use the VDR MAC in \"vdr_mac_nested\". If the host switch is in some OVERLAY transport zone(s) whose \"nested_nsx\" property is true, the first way is updating the \"vdr_mac_nested\" property. The 2nd way is updating all those OVERLAY tranport zones to set \"nested_nsx\" property false which will make the host switch use the VDR MAC in \"vdr_mac\". The third way is directly updating the transport node to remove all those OVERLAY transport zones from the host switch which will also make the host switch use the VDR MAC in \"vdr_mac\". Please note that changing the VDR MAC being used by existing transport nodes will most likely cause traffic disruption and network outage!", 
      "title": "A flag to indicate if changing the VDR MAC being used is allowed", 
      "type": "boolean"
    }, 
    "arp_limit_per_gateway": {
      "Default": 50000, 
      "description": "Global configuration of maximum number of ARP entries per transport node at each Tier0/Tier1 gateway.", 
      "maximum": 50000, 
      "minimum": 5000, 
      "title": "ARP limit per Tier0/Tier1 gateway", 
      "type": "int"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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"
    }, 
    "fips": {
      "$ref": "FIPSGlobalConfig, 
      "description": "Contains the FIPSGlobalConfig object.", 
      "required": false, 
      "title": "FIPS enabled config"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "l3_forwarding_mode": {
      "default": "IPV4_ONLY", 
      "description": "Configure forwarding mode for routing. This setting does not restrict configuration for other modes.", 
      "enum": [
        "IPV4_ONLY", 
        "IPV4_AND_IPV6"
      ], 
      "required": false, 
      "title": "L3 forwarding mode", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "mtu": {
      "description": "Maximum transmission unit (MTU) specifies the size of the largest packet that a network protocol can transmit.", 
      "minimum": 1280, 
      "required": false, 
      "title": "MTU size", 
      "type": "int"
    }, 
    "operation_collectors": {
      "description": "The operation collector is defined to receive stats from hosts. The VRNI and WAVE_FRONT collector type can be defined to collect the metric data. The WAVE_FRONT collector type can only be used in VMC mode.", 
      "items": {
        "$ref": "GlobalCollectorConfig
      }, 
      "required": false, 
      "title": "Operation global collector config", 
      "type": "array"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }, 
    "uplink_mtu_threshold": {
      "default": 9000, 
      "description": "This value defines the upper threshold for the Maximum Transmission Unit (MTU) value that can be configured at a physical uplink level or a logical routing uplink level in a NSX domain. All Uplink profiles validate against this value so that the MTU specified in an Uplink profile does not exceed this global upper threshold. Similarly, when this value is modified, the new value must be greater than or equal to any existing Uplink profile's MTU.", 
      "required": false, 
      "title": "Upper threshold for MTU on physical and logical uplinks", 
      "type": "int"
    }, 
    "vdr_mac": {
      "$ref": "MACAddress, 
      "default": "02:50:56:56:44:52", 
      "description": "This is the global default MAC address for all VDRs in all transport nodes in a NSX system. It can be changed only when there is no transport node in the NSX system. This value cannot be same as vdr_mac_nested. When the property \"allow_changing_vdr_mac_in_use\" is false, it can not be changed if the current VDR MAC is being used by any transport node. A transport node uses this VDR MAC if any host switch in the node is in OVERLAY transport zone(s) but none of the transport zone(s) has \"nested_nsx\" property being true.", 
      "title": "MAC address of the Virtual Distributed Router (VDR) port"
    }, 
    "vdr_mac_nested": {
      "$ref": "MACAddress, 
      "default": "02:50:56:56:44:53", 
      "description": "This is the global default MAC address for all VDRs in all transport nodes in a NSX system nested in another NSX system. It can be changed only when there is no transport node in the NSX system. All transport zones in such a nested NSX system will have the \"nested_nsx\" property being true so that all transport nodes will use this MAC for the VDR ports to avoid conflict with the VDR MAC in the outer NSX system. When the property \"allow_changing_vdr_mac_in_use\" is false, it can not be changed if the current VDR MAC is being used by any transport node in a nested NSX environment. A transport node uses this VDR MAC if any host switch in the node is in an OVERLAY transport zone whose \"nested_nsx\" property is true.", 
      "title": "The MAC address of the Virtual Distributed Router (VDR) port in a nested NSX environment."
    }
  }, 
  "title": "Global configuration", 
  "type": "object"
}

GlobalIdsSignature (type)

{
  "additionalProperties": false, 
  "description": "Global IDS signature.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "GlobalIdsSignature", 
  "module_id": "PolicyIDS", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "action": {
      "description": "It denotes the global action of a IDS Signature. This will take precedence over IDS signature's action.", 
      "enum": [
        "ALERT", 
        "DROP", 
        "REJECT"
      ], 
      "title": "Global IDS signature's action", 
      "type": "string"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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"
    }, 
    "enable": {
      "default": true, 
      "description": "Flag through which user can Enable/Disable a Signature at Global Level.", 
      "title": "Flag to Enable/Disable a IDS Signature globally.", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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"
    }, 
    "signature_id": {
      "description": "Represents the Signature's id.", 
      "required": true, 
      "title": "Signature ID", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Global IDS signature", 
  "type": "object"
}

GlobalManager (type)

{
  "additionalProperties": false, 
  "description": "Global Manager.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "GlobalManager", 
  "module_id": "PolicySiteGM", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "connection_info": {
      "description": "To create a standby GM, the connection information (username, password, and API thumbprint) for at least one NSX manager node in the remote site must be provided. Once the GM has been successfully onboarded, the connection_info is discarded and authentication to the standby GM occurs using an X.509 client certificate.", 
      "items": {
        "$ref": "SiteNodeConnectionInfo
      }, 
      "maxItems": 3, 
      "title": "Connection information", 
      "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"
    }, 
    "fail_if_rtt_exceeded": {
      "default": true, 
      "description": "Fail onboarding if maximum RTT exceeded.", 
      "title": "Fail onboarding if maximum RTT exceeded", 
      "type": "boolean"
    }, 
    "federation_id": {
      "description": "Internally generated UUID to the federation of Global Manager.", 
      "readonly": true, 
      "title": "Global manager federation UUID", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "maximum_rtt": {
      "default": 250, 
      "description": "If provided and fail_if_rtt_exceeded is true, onboarding of the site will fail if measured RTT is greater than this value.", 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum acceptable packet round trip time (RTT)", 
      "type": "integer"
    }, 
    "mode": {
      "description": "There can be at most one ACTIVE global manager and one STANDBY global manager. In order to add a STANDBY manager, there must be an ACTIVE manager defined.", 
      "enum": [
        "ACTIVE", 
        "STANDBY"
      ], 
      "required": true, 
      "title": "Mode of the global manager", 
      "type": "string"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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"
    }, 
    "site_id": {
      "description": "UUID of the site where Global manager is running. This is the Site Manager generated UUID for every NSX deployment.", 
      "readonly": true, 
      "title": "UUID of the site where Global manager is running", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Global Manager", 
  "type": "object"
}

GlobalManagerConfig (type)

{
  "additionalProperties": false, 
  "description": "This configuration is distributed to all Sites participating in federation.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "GlobalManagerConfig", 
  "module_id": "PolicySiteGM", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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"
    }, 
    "rtep_config": {
      "$ref": "GmRtepConfig, 
      "description": "Global Manager federation RTEP configuration. This configuration is distributed to all Sites participating in federation.", 
      "required": false, 
      "title": "Global Manager federation RTEP configuration"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Global Manager configuration", 
  "type": "object"
}

GlobalManagerListRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "Site list request parameters.", 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "GlobalManagerListRequestParameters", 
  "module_id": "PolicySiteGM", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Site List Request Parameters", 
  "type": "object"
}

GlobalManagerListResult (type)

{
  "additionalProperties": false, 
  "description": "Paged Collection of Global Managers.", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "GlobalManagerListResult", 
  "module_id": "PolicySiteGM", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Global Manager List Result.", 
      "items": {
        "$ref": "GlobalManager
      }, 
      "required": true, 
      "title": "Global Manager List Result", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of Global Managers", 
  "type": "object"
}

GlobalManagerSwitchOverRequestParameter (type)

{
  "description": "Parameter to force switch over from Standby to Active.", 
  "id": "GlobalManagerSwitchOverRequestParameter", 
  "module_id": "PolicySiteGM", 
  "properties": {
    "force": {
      "description": "If true indicates that user requested make standby Global Manager as active ignoring the state of current active Global Manager. Typically, recommended to use when active Global Manager is failed or not reachable.", 
      "title": "Indciates force switchover to Active", 
      "type": "boolean"
    }
  }, 
  "title": "Parameter to force switchover", 
  "type": "object"
}

GlobalRestoreStatus (type)

{
  "id": "GlobalRestoreStatus", 
  "module_id": "ClusterRestore", 
  "properties": {
    "description": {
      "readonly": true, 
      "required": true, 
      "title": "A description of the restore status", 
      "type": "string"
    }, 
    "value": {
      "enum": [
        "INITIAL", 
        "SUCCESS", 
        "FAILED", 
        "RUNNING", 
        "SUSPENDED_BY_USER", 
        "SUSPENDED_FOR_USER_ACTION", 
        "SUSPENDED", 
        "ABORTED"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Global rolled-up restore status value", 
      "type": "string"
    }
  }, 
  "title": "Overall restore process status", 
  "type": "object"
}

GmFederationSiteConfig (type)

{
  "additionalProperties": false, 
  "description": "Additional configuration required for federation at Site.", 
  "id": "GmFederationSiteConfig", 
  "module_id": "PolicyEnforcementPointManagement", 
  "properties": {
    "transit_subnet": {
      "description": "IP Addresses to be allocated for transit segment when the gateway is stretched. Note that Global Manager will carve out the IP Pool for each site to be used for edge nodes when gateway is stretched based on the user provided subnet and maximum number of edge nodes allowed per site.", 
      "format": "ip-cidr-block", 
      "readlony": true, 
      "title": "Transit subnet in CIDR format", 
      "type": "string"
    }
  }, 
  "title": "Federation configuration for the site", 
  "type": "object"
}

GmNodeStatus (type)

{
  "id": "GmNodeStatus", 
  "module_id": "GmOperationalState", 
  "properties": {
    "end_time": {
      "read_only": true, 
      "title": "End time of the switchover operation", 
      "type": "integer"
    }, 
    "errors": {
      "items": {
        "type": "string"
      }, 
      "read_only": true, 
      "title": "Errors if any", 
      "type": "array"
    }, 
    "node_id": {
      "read_only": true, 
      "title": "UUID of the Global Manager node", 
      "type": "string"
    }, 
    "start_time": {
      "read_only": true, 
      "title": "Start time of the switchover operation", 
      "type": "integer"
    }, 
    "status": {
      "enum": [
        "IN_PROGRESS", 
        "COMPLETED", 
        "FAILED"
      ], 
      "read_only": true, 
      "title": "Status of switchover operation", 
      "type": "string"
    }, 
    "warnings": {
      "items": {
        "type": "string"
      }, 
      "read_only": true, 
      "title": "Errors if any", 
      "type": "array"
    }
  }, 
  "title": "Represents the Global Manager node switchover status", 
  "type": "object"
}

GmOperationalState (type)

{
  "description": "Represents the switchover operational state of Global Manager. Offers information about the current switchover operation including status from each Global Manager node and the errors if any.", 
  "id": "GmOperationalState", 
  "module_id": "GmOperationalState", 
  "properties": {
    "consolidated_progress": {
      "enum": [
        "IN_PROGRESS", 
        "COMPLETED", 
        "FAILED"
      ], 
      "read_only": true, 
      "title": "Consolidated status of the current operation", 
      "type": "string"
    }, 
    "end_time": {
      "read_only": true, 
      "title": "End time of the switchover operation", 
      "type": "integer"
    }, 
    "errors": {
      "items": {
        "type": "string"
      }, 
      "read_only": true, 
      "title": "Errors if any", 
      "type": "array"
    }, 
    "node_statuses": {
      "items": {
        "$ref": "GmNodeStatus
      }, 
      "read_only": true, 
      "title": "Switchover status from each NSX Global Manager appliance node", 
      "type": "array"
    }, 
    "site_manager_ref": {
      "read_only": true, 
      "title": "Timestamp reference for the change provided by SiteManager", 
      "type": "integer"
    }, 
    "start_time": {
      "read_only": true, 
      "title": "Start time of the switchover operation", 
      "type": "integer"
    }, 
    "status": {
      "enum": [
        "NONE", 
        "ACTIVE", 
        "STANDBY", 
        "SWITCHING_TO_ACTIVE", 
        "SWITCHING_TO_STANDBY", 
        "DECOMMISSIONED"
      ], 
      "read_only": true, 
      "required": true, 
      "title": "The current switchover operation requested.", 
      "type": "string"
    }, 
    "warnings": {
      "items": {
        "type": "string"
      }, 
      "read_only": true, 
      "title": "Errors if any", 
      "type": "array"
    }
  }, 
  "title": "Represents the operational state of Global Manager", 
  "type": "object"
}

GmRtepConfig (type)

{
  "additionalProperties": false, 
  "description": "Global Manager federation RTEP configuration. This configuration is distributed to all Sites participating in federation.", 
  "id": "GmRtepConfig", 
  "module_id": "PolicySiteGM", 
  "properties": {
    "ibgp_password": {
      "description": "Password to authenticate IBGP session between remote tunnel endpoints created on federated sites. This is applied to inter-site underlay IBGP neighbors created over remote tunnel endpoints on all sites. Empty string (\"\") clears existing password.", 
      "maxLength": 20, 
      "required": false, 
      "sensitive": true, 
      "title": "Password for IBGP sessions between federated sites", 
      "type": "string"
    }
  }, 
  "title": "Global Manager federation RTEP configuration", 
  "type": "object"
}

GraphConfiguration (type)

{
  "additionalProperties": false, 
  "description": "Represents configuration of a graph widget", 
  "extends": {
    "$ref": "WidgetConfiguration
  }, 
  "id": "GraphConfiguration", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "polymorphic-type-descriptor": {
    "type-identifier": "GraphConfiguration"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "axes": {
      "$ref": "Axes, 
      "desription": "Represents the Axes of a graph. If axes is not specified, labels are not applied to the axes.", 
      "title": "Axes of a graph"
    }, 
    "datasources": {
      "description": "The 'datasources' represent the sources from which data will be fetched. Currently, only NSX-API is supported as a 'default' datasource. An example of specifying 'default' datasource along with the urls to fetch data from is given at 'example_request' section of 'CreateWidgetConfiguration' API.", 
      "items": {
        "$ref": "Datasource
      }, 
      "minItems": 0, 
      "title": "Array of Datasource Instances with their relative urls", 
      "type": "array"
    }, 
    "default_filter_value": {
      "description": "Default filter values to be passed to datasources. This will be used when the report is requested without filter values.", 
      "items": {
        "$ref": "DefaultFilterValue
      }, 
      "title": "Default filter value to be passed to datasources", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "description": "Title of the widget. If display_name is omitted, the widget will be shown without a title.", 
      "maxLength": 255, 
      "title": "Widget Title", 
      "type": "string"
    }, 
    "display_x_value": {
      "default": false, 
      "description": "If true, value of a point is shown as label on X axis. If false, value of point is not shown as label on X axis. false can be useful in situations where there are too many points and showing the X value as label can clutter the X axis.", 
      "title": "Show or hide the value of a point on X axis", 
      "type": "boolean"
    }, 
    "drilldown_id": {
      "description": "Id of drilldown widget, if any. Id should be a valid id of an existing widget. A widget is considered as drilldown widget when it is associated with any other widget and provides more detailed information about any data item from the parent widget.", 
      "maxLength": 255, 
      "title": "Id of drilldown widget", 
      "type": "string"
    }, 
    "feature_set": {
      "$ref": "FeatureSet, 
      "description": "Features required to view the widget.", 
      "title": "Features required to view the widget"
    }, 
    "filter": {
      "description": "Id of filter widget for subscription, if any. Id should be a valid id of an existing filter widget. Filter widget should be from the same view. Datasource URLs should have placeholder values equal to filter alias to accept the filter value on filter change.", 
      "title": "Id of filter widget for subscription", 
      "type": "string"
    }, 
    "filter_value_required": {
      "default": true, 
      "description": "Flag to indicate that widget will continue to work without filter value. If this flag is set to false then default_filter_value is manadatory.", 
      "title": "Flag to indicate if filter value is necessary", 
      "type": "boolean"
    }, 
    "footer": {
      "$ref": "Footer
    }, 
    "graphs": {
      "decription": "Array of graphs to be plotted on the Axes. If more than 1 graph needs to be shown on the same axes, each graph will be distinguished by its color and legend.", 
      "items": {
        "$ref": "GraphDefinition
      }, 
      "minItems": 1, 
      "required": true, 
      "title": "Graphs", 
      "type": "array"
    }, 
    "icons": {
      "description": "Icons to be applied at dashboard for widgets and UI elements.", 
      "items": {
        "$ref": "Icon
      }, 
      "title": "Icons", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "is_drilldown": {
      "default": false, 
      "description": "Set to true if this widget should be used as a drilldown.", 
      "title": "Set as a drilldown widget", 
      "type": "boolean"
    }, 
    "legend": {
      "$ref": "Legend, 
      "description": "Legend to be displayed. If legend is not needed, do not include it.", 
      "title": "Legend for the widget"
    }, 
    "navigation": {
      "description": "Hyperlink of the specified UI page that provides details.", 
      "title": "Navigation to a specified UI page", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "Supported visualization types are LabelValueConfiguration, DonutConfiguration, GridConfiguration, StatsConfiguration, MultiWidgetConfiguration, GraphConfiguration, ContainerConfiguration, CustomWidgetConfiguration and DropdownFilterWidgetConfiguration.", 
      "enum": [
        "LabelValueConfiguration", 
        "DonutConfiguration", 
        "MultiWidgetConfiguration", 
        "ContainerConfiguration", 
        "StatsConfiguration", 
        "GridConfiguration", 
        "GraphConfiguration", 
        "CustomWidgetConfiguration", 
        "DropdownFilterWidgetConfiguration"
      ], 
      "maxLength": 255, 
      "readonly": true, 
      "required": true, 
      "title": "Widget visualization type", 
      "type": "string"
    }, 
    "shared": {
      "deprecated": true, 
      "description": "Please use the property 'shared' of View instead of this. The widgets of a shared view are visible to other users.", 
      "title": "Visiblity of widgets to other users", 
      "type": "boolean"
    }, 
    "span": {
      "description": "Represents the horizontal span of the widget / container.", 
      "maximum": 12, 
      "minimum": 1, 
      "title": "Horizontal span", 
      "type": "int"
    }, 
    "sub_type": {
      "default": "BAR_GRAPH", 
      "description": "Describes the the type of graph. LINE_GRAPH shows a line graph chart BAR_GRAPH shows a simple bar graph chart STACKED_BAR_GRAPH shows a stacked bar graph chart", 
      "enum": [
        "LINE_GRAPH", 
        "BAR_GRAPH", 
        "STACKED_BAR_GRAPH"
      ], 
      "title": "Subtype of a graph", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "weight": {
      "deprecated": true, 
      "description": "Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details.", 
      "title": "Weightage or placement of the widget or container", 
      "type": "int"
    }, 
    "x_value_type": {
      "default": "string", 
      "description": "x value type.", 
      "enum": [
        "string", 
        "number", 
        "date"
      ], 
      "required": false, 
      "title": "x value type", 
      "type": "string"
    }
  }, 
  "title": "Graph Configuration", 
  "type": "object"
}

GraphDefinition (type)

{
  "additionalProperties": false, 
  "description": "Defines a graph", 
  "id": "GraphDefinition", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "properties": {
    "id": {
      "description": "Identifier of graph. It can be used to differentiate multiple graph series present in GraphWidgetConfiguration.", 
      "title": "Identifier of graph", 
      "type": "string"
    }, 
    "label": {
      "$ref": "Label, 
      "description": "Describes the graph. It labels the entities of graph. If the label is not provided then it is not shown for a graph. For example, for a single graph, the title of widget can describe the graph and a label may not be necessary to be shown.", 
      "title": "Label of a graph"
    }, 
    "point_definition": {
      "$ref": "PointDefinition, 
      "description": "Defines the points of a graph.", 
      "required": true, 
      "title": "Definition for points of a graph"
    }, 
    "render_configuration": {
      "description": "Additional rendering or conditional evaluation of the field values to be performed, if any.", 
      "items": {
        "$ref": "RenderConfiguration
      }, 
      "minItems": 0, 
      "title": "Render Configuration", 
      "type": "array"
    }
  }, 
  "title": "Definition of a graph", 
  "type": "object"
}

GridConfiguration (type)

{
  "additionalProperties": false, 
  "description": "Represents configuration of a Grid or Table widget.", 
  "extends": {
    "$ref": "WidgetConfiguration
  }, 
  "id": "GridConfiguration", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "polymorphic-type-descriptor": {
    "type-identifier": "GridConfiguration"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "columns": {
      "description": "Array of columns of a Grid widget", 
      "items": {
        "$ref": "ColumnItem
      }, 
      "required": true, 
      "title": "Columns", 
      "type": "array"
    }, 
    "datasources": {
      "description": "The 'datasources' represent the sources from which data will be fetched. Currently, only NSX-API is supported as a 'default' datasource. An example of specifying 'default' datasource along with the urls to fetch data from is given at 'example_request' section of 'CreateWidgetConfiguration' API.", 
      "items": {
        "$ref": "Datasource
      }, 
      "minItems": 0, 
      "title": "Array of Datasource Instances with their relative urls", 
      "type": "array"
    }, 
    "default_filter_value": {
      "description": "Default filter values to be passed to datasources. This will be used when the report is requested without filter values.", 
      "items": {
        "$ref": "DefaultFilterValue
      }, 
      "title": "Default filter value to be passed to datasources", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "description": "Title of the widget. If display_name is omitted, the widget will be shown without a title.", 
      "maxLength": 255, 
      "title": "Widget Title", 
      "type": "string"
    }, 
    "drilldown_id": {
      "description": "Id of drilldown widget, if any. Id should be a valid id of an existing widget. A widget is considered as drilldown widget when it is associated with any other widget and provides more detailed information about any data item from the parent widget.", 
      "maxLength": 255, 
      "title": "Id of drilldown widget", 
      "type": "string"
    }, 
    "feature_set": {
      "$ref": "FeatureSet, 
      "description": "Features required to view the widget.", 
      "title": "Features required to view the widget"
    }, 
    "filter": {
      "description": "Id of filter widget for subscription, if any. Id should be a valid id of an existing filter widget. Filter widget should be from the same view. Datasource URLs should have placeholder values equal to filter alias to accept the filter value on filter change.", 
      "title": "Id of filter widget for subscription", 
      "type": "string"
    }, 
    "filter_value_required": {
      "default": true, 
      "description": "Flag to indicate that widget will continue to work without filter value. If this flag is set to false then default_filter_value is manadatory.", 
      "title": "Flag to indicate if filter value is necessary", 
      "type": "boolean"
    }, 
    "footer": {
      "$ref": "Footer
    }, 
    "icons": {
      "description": "Icons to be applied at dashboard for widgets and UI elements.", 
      "items": {
        "$ref": "Icon
      }, 
      "title": "Icons", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "is_drilldown": {
      "default": false, 
      "description": "Set to true if this widget should be used as a drilldown.", 
      "title": "Set as a drilldown widget", 
      "type": "boolean"
    }, 
    "legend": {
      "$ref": "Legend, 
      "description": "Legend to be displayed. If legend is not needed, do not include it.", 
      "title": "Legend for the widget"
    }, 
    "page_size": {
      "default": 30, 
      "description": "Number of records per page. page_size will be effective only when the urls provided in the datasource support paging.", 
      "title": "Page Size", 
      "type": "int"
    }, 
    "resource_type": {
      "description": "Supported visualization types are LabelValueConfiguration, DonutConfiguration, GridConfiguration, StatsConfiguration, MultiWidgetConfiguration, GraphConfiguration, ContainerConfiguration, CustomWidgetConfiguration and DropdownFilterWidgetConfiguration.", 
      "enum": [
        "LabelValueConfiguration", 
        "DonutConfiguration", 
        "MultiWidgetConfiguration", 
        "ContainerConfiguration", 
        "StatsConfiguration", 
        "GridConfiguration", 
        "GraphConfiguration", 
        "CustomWidgetConfiguration", 
        "DropdownFilterWidgetConfiguration"
      ], 
      "maxLength": 255, 
      "readonly": true, 
      "required": true, 
      "title": "Widget visualization type", 
      "type": "string"
    }, 
    "row_list_fields": {
      "description": "Rows of grid or table are formed from the list of objects returned by a row list field.", 
      "items": {
        "$ref": "RowListField
      }, 
      "minItems": 1, 
      "required": true, 
      "title": "List of fields from which rows are formed", 
      "type": "array"
    }, 
    "shared": {
      "deprecated": true, 
      "description": "Please use the property 'shared' of View instead of this. The widgets of a shared view are visible to other users.", 
      "title": "Visiblity of widgets to other users", 
      "type": "boolean"
    }, 
    "span": {
      "description": "Represents the horizontal span of the widget / container.", 
      "maximum": 12, 
      "minimum": 1, 
      "title": "Horizontal span", 
      "type": "int"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "weight": {
      "deprecated": true, 
      "description": "Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details.", 
      "title": "Weightage or placement of the widget or container", 
      "type": "int"
    }
  }, 
  "title": "Grid Configuration", 
  "type": "object"
}

Group (type)

{
  "additionalProperties": false, 
  "description": "Group.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "Group", 
  "module_id": "Policy", 
  "policy_hierarchical_children": [
    "ChildDnsSecurityProfileBindingMap", 
    "ChildGroupDiscoveryProfileBindingMap", 
    "ChildGroupMonitoringProfileBindingMap", 
    "ChildPolicyFirewallFloodProtectionProfileBindingMap", 
    "ChildPolicyFirewallSessionTimerProfileBindingMap"
  ], 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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"
    }, 
    "expression": {
      "description": "The expression list must follow below criteria:   1. A non-empty expression list, must be of odd size. In a list, with   indices starting from 0, all non-conjunction expressions must be at   even indices, separated by a conjunction expression at odd   indices.   2. The total of ConditionExpression and NestedExpression in a list   should not exceed 5.   3. The total of IPAddressExpression, MACAddressExpression, external   IDs in an ExternalIDExpression and paths in a PathExpression must not exceed   500.   4. Each expression must be a valid Expression. See the definition of   the Expression type for more information.", 
      "items": {
        "$ref": "Expression
      }, 
      "required": false, 
      "title": "Expression", 
      "type": "array"
    }, 
    "extended_expression": {
      "description": "Extended Expression allows additional higher level context to be specified for grouping criteria. (e.g. user AD group) This field allow users to specified user context as the source of a firewall rule for IDFW feature. Current version only support a single IdentityGroupExpression. In the future, this might expand to support other conjunction and non-conjunction expression.  The extended expression list must follow below criteria: 1. Contains a single IdentityGroupExpression. No conjunction expression is supported. 2. No other non-conjunction expression is supported, except for IdentityGroupExpression. 3. Each expression must be a valid Expression. See the definition of the Expression type for more information. 4. Extended expression are implicitly AND with expression. 5. No nesting can be supported if this value is used. 6. If a Group is using extended expression, this group must be the only member in the source field of an communication map.", 
      "items": {
        "$ref": "Expression
      }, 
      "maxItems": 1, 
      "required": false, 
      "title": "Extended Expression", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "reference": {
      "default": false, 
      "description": "If true, indicates that this is a remote reference group. Such group will have span different from the its parent domain. Default value is false.", 
      "readonly": true, 
      "title": "Indicates if the group is a reference.", 
      "type": "boolean"
    }, 
    "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Group", 
  "type": "object"
}

GroupDeleteRequestParameters (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "extends": {
    "$ref": "DeleteRequestParameters
  }, 
  "id": "GroupDeleteRequestParameters", 
  "module_id": "Policy", 
  "properties": {
    "fail_if_subtree_exists": {
      "default": false, 
      "description": "Check if the group sub-tree has any entities. These primarily include the binding maps that point to various profiles. If this flag is passed as true, the group delete fails if any binding maps exist in the group sub-tree. By default, this flag is false, which means that the group is deleted along with the group sub-tree.", 
      "title": "Do not delete if the group subtree has any entities", 
      "type": "boolean"
    }, 
    "force": {
      "default": false, 
      "description": "If true, deleting the resource succeeds even if it is being referred as a resource reference.", 
      "title": "Force delete the resource even if it is being used somewhere\n", 
      "type": "boolean"
    }
  }, 
  "title": "Group delete request parameters", 
  "type": "object"
}

GroupDiscoveryProfileBindingMap (type)

{
  "additionalProperties": false, 
  "description": "This entity will be used to establish association between discovery profile and Group. With this entity, user can specify intent for applying discovery profile profile to particular Group.", 
  "extends": {
    "$ref": "ProfileBindingMap
  }, 
  "id": "GroupDiscoveryProfileBindingMap", 
  "module_id": "PolicyDiscoveryProfileBinding", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "profile_path": {
      "description": "PolicyPath of associated Profile", 
      "required": true, 
      "title": "Profile Path", 
      "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": "Sequence number used to resolve conflicts betweeen two profiles applied on the same group. Lower sequence number takes higher precedence. Two binding maps applied to the same profile must have the same sequence number. User defined sequence numbers range from 1 through 100,000. System defined sequence numbers range from 100,001 through 200,000.", 
      "maximum": 100000, 
      "minimum": 1, 
      "requried": true, 
      "title": "Sequence number group discovery profile Binding Map", 
      "type": "integer"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Map for binding group with discovery profile", 
  "type": "object"
}

GroupDiscoveryProfileBindingMapListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "GroupDiscoveryProfileBindingMapListRequestParameters", 
  "module_id": "PolicyDiscoveryProfileBinding", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Group Discovery Profile Binding Map List Request Parameters", 
  "type": "object"
}

GroupDiscoveryProfileBindingMapListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "GroupDiscoveryProfileBindingMapListResult", 
  "module_id": "PolicyDiscoveryProfileBinding", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "GroupDiscoveryProfileBindingMap
      }, 
      "requried": true, 
      "title": "Group Discovery Profile Binding Map List Results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged collection of Group Discovery Profile Binding Map", 
  "type": "object"
}

GroupListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "GroupListRequestParameters", 
  "module_id": "Policy", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "member_types": {
      "description": "Optionally, specify valid member types as request parameter to filter NSGroups.", 
      "required": false, 
      "title": "Comma Seperated Member types", 
      "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, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "GroupListResult", 
  "module_id": "Policy", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "Group
      }, 
      "required": true, 
      "title": "Group list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of Groups", 
  "type": "object"
}

GroupMemberActionParameters (type)

{
  "additionalProperties": false, 
  "description": "Request Parameter to either add or remove the Group members.", 
  "id": "GroupMemberActionParameters", 
  "module_id": "Policy", 
  "properties": {
    "action": {
      "description": "Action parameter determines whether to add or remove the group members.", 
      "enum": [
        "add", 
        "remove"
      ], 
      "required": true, 
      "title": "Add or Remove group members.", 
      "type": "string"
    }
  }, 
  "title": "Request Parameters for Group members", 
  "type": "object"
}

GroupMemberList (type)

{
  "additionalProperties": false, 
  "description": "List of same type members to either add or remove from a group.", 
  "id": "GroupMemberList", 
  "module_id": "Policy", 
  "properties": {
    "members": {
      "description": "This array contains group members of similar types.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 4000, 
      "minItems": 1, 
      "required": true, 
      "title": "Groups members collection", 
      "type": "array"
    }
  }, 
  "title": "Members to add or remove for a Group.", 
  "type": "object"
}

GroupMemberTagsList (type)

{
  "additionalProperties": false, 
  "description": "Collection of tags used in a policy group for a particular member type", 
  "id": "GroupMemberTagsList", 
  "module_id": "PolicyGroupRealization", 
  "properties": {
    "member_type": {
      "required": true, 
      "title": "Member type for which we will list the tags", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "type": "string"
      }, 
      "required": true, 
      "title": "List of tags for the member type", 
      "type": "array"
    }
  }, 
  "title": "Group tags list for a particular member type", 
  "type": "object"
}

GroupMemberType (type)

{
  "enum": [
    "VirtualMachine", 
    "VirtualNetworkInterface", 
    "SegmentPort", 
    "Segment", 
    "CloudNativeServiceInstance", 
    "IPAddress", 
    "MACAddress", 
    "IPSet", 
    "IdentityGroup", 
    "PhysicalServer"
  ], 
  "id": "GroupMemberType", 
  "module_id": "Policy", 
  "title": "Valid Group member type", 
  "type": "string"
}

GroupMemberTypeListResult (type)

{
  "additionalProperties": false, 
  "id": "GroupMemberTypeListResult", 
  "module_id": "Policy", 
  "properties": {
    "result_count": {
      "readonly": true, 
      "required": true, 
      "title": "Count of the member types in the results array", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "GroupMemberType
      }, 
      "required": true, 
      "title": "Collection of member types for the given Group", 
      "type": "array"
    }
  }, 
  "type": "object"
}

GroupMonitoringProfileBindingMap (type)

{
  "additionalProperties": false, 
  "description": "This entity will be used to establish association between monitoring profile and Group. Using this entity, you can specify intent for applying monitoring profile to particular Group. Group with membership criteria vm only supported as source group. Port mirroring is only supported on group with five vms.", 
  "extends": {
    "$ref": "MonitoringProfileBindingMap
  }, 
  "id": "GroupMonitoringProfileBindingMap", 
  "module_id": "PolicyMonitoringProfileBinding", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ipfix_dfw_profile_path": {
      "description": "PolicyPath of associated IPFIX DFW Profile", 
      "required": false, 
      "title": "IPFIX DFW Profile Path", 
      "type": "string"
    }, 
    "ipfix_l2_profile_path": {
      "description": "PolicyPath of associated IPFIX L2 Profile", 
      "required": false, 
      "title": "IPFIX L2 Profile Path", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "port_mirroring_profile_path": {
      "description": "PolicyPath of associated Port Mirroring Profile", 
      "required": false, 
      "title": "Port Mirroring Profile Path", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Group Monitoring Profile binding map", 
  "type": "object"
}

GroupMonitoringProfileBindingMapListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "GroupMonitoringProfileBindingMapListRequestParameters", 
  "module_id": "PolicyMonitoringProfileBinding", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Group Monitoring Profile Binding Map list request parameters", 
  "type": "object"
}

GroupMonitoringProfileBindingMapListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "GroupMonitoringProfileBindingMapListResult", 
  "module_id": "PolicyMonitoringProfileBinding", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "GroupMonitoringProfileBindingMap
      }, 
      "required": true, 
      "title": "Group Monitoring Profile Binding Map list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged collection of Group Monitoring Profile Binding Maps", 
  "type": "object"
}

GroupStatusListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "GroupStatusListRequestParameters", 
  "module_id": "Upgrade", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "has_errors": {
      "default": false, 
      "readonly": false, 
      "required": false, 
      "title": "Flag to indicate whether to return only upgrade units with errors", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

GroupTagsList (type)

{
  "additionalProperties": false, 
  "description": "Collection of tags used in a policy group listed per member type", 
  "id": "GroupTagsList", 
  "module_id": "PolicyGroupRealization", 
  "properties": {
    "results": {
      "items": {
        "$ref": "GroupMemberTagsList
      }, 
      "required": true, 
      "title": "Collection of tags used in a policy group listed per member type", 
      "type": "array"
    }
  }, 
  "title": "Group tags list listed per member type", 
  "type": "object"
}

GuestInfo (type)

{
  "additionalProperties": false, 
  "description": "Guest virtual machine details include OS name and computer name of guest VM.", 
  "id": "GuestInfo", 
  "module_id": "Inventory", 
  "properties": {
    "computer_name": {
      "description": "Computer name of guest virtual machine, which is set inside guest OS. Currently this is supported for guests on ESXi that have VMware Tools installed.", 
      "readonly": true, 
      "required": false, 
      "title": "Computer name", 
      "type": "string"
    }, 
    "os_name": {
      "description": "OS name of guest virtual machine. Currently this is supported for guests on ESXi that have VMware Tools installed.", 
      "readonly": true, 
      "required": false, 
      "title": "OS name", 
      "type": "string"
    }
  }, 
  "title": "Guest virtual machine details", 
  "type": "object"
}

Header (type)

{
  "additionalProperties": false, 
  "description": "Header of a widget that provides additional information. This will be shown at the container level. It includes details as label value pairs.", 
  "id": "Header", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "properties": {
    "condition": {
      "description": "If the condition is met then the header will be applied. Examples of expression syntax are provided under 'example_request' section of 'CreateWidgetConfiguration' API.", 
      "maxLength": 1024, 
      "title": "Expression for evaluating condition", 
      "type": "string"
    }, 
    "content_alignment": {
      "default": "RIGHT", 
      "description": "Alignment of header labels.", 
      "enum": [
        "LEFT", 
        "RIGHT"
      ], 
      "title": "alignment for labelvalue pair", 
      "type": "string"
    }, 
    "sub_headers": {
      "description": "An array of label-value properties.", 
      "items": {
        "$ref": "PropertyItem
      }, 
      "minItems": 0, 
      "title": "Rows", 
      "type": "array"
    }
  }, 
  "title": "Widget Header", 
  "type": "object"
}

HostUpgradeStatus (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ComponentUpgradeStatus
  }, 
  "id": "HostUpgradeStatus", 
  "module_id": "Upgrade", 
  "properties": {
    "can_skip": {
      "readonly": true, 
      "required": false, 
      "title": "Can the upgrade of the remaining units in this component be skipped", 
      "type": "boolean"
    }, 
    "component_type": {
      "readonly": true, 
      "required": false, 
      "title": "Component type for the upgrade status", 
      "type": "string"
    }, 
    "current_version_node_summary": {
      "$ref": "NodeSummaryList, 
      "readonly": true, 
      "required": false, 
      "title": "Mapping of current versions of nodes and counts of nodes at the respective versions."
    }, 
    "details": {
      "readonly": true, 
      "required": false, 
      "title": "Details about the upgrade status", 
      "type": "string"
    }, 
    "node_count_at_target_version": {
      "description": "Number of nodes of the type and at the component version", 
      "readonly": true, 
      "required": false, 
      "title": "Count of nodes at target component version", 
      "type": "int"
    }, 
    "percent_complete": {
      "readonly": true, 
      "required": true, 
      "title": "Indicator of upgrade progress in percentage", 
      "type": "number"
    }, 
    "pre_upgrade_status": {
      "$ref": "UpgradeChecksExecutionStatus, 
      "readonly": true, 
      "required": false, 
      "title": "Pre-upgrade status of the component-type"
    }, 
    "status": {
      "enum": [
        "SUCCESS", 
        "FAILED", 
        "IN_PROGRESS", 
        "NOT_STARTED", 
        "PAUSING", 
        "PAUSED"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Upgrade status of component", 
      "type": "string"
    }, 
    "target_component_version": {
      "readonly": true, 
      "required": false, 
      "title": "Target component version", 
      "type": "string"
    }
  }, 
  "title": "Status of host upgrade", 
  "type": "object"
}

HostnameOrIPv4Address (type)

{
  "format": "hostname-or-ipv4", 
  "id": "HostnameOrIPv4Address", 
  "module_id": "Common", 
  "title": "Hostname or IPv4 address", 
  "type": "string"
}

HostnameOrIPv4AddressOrEmptyString (type)

{
  "id": "HostnameOrIPv4AddressOrEmptyString", 
  "maxLength": 255, 
  "module_id": "Common", 
  "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"
}

HttpPolicyLbMonitorProfile (type)

{
  "additionalProperties": false, 
  "description": "Active healthchecks are disabled by default and can be enabled for a server pool by binding a health monitor to the Group through the PolicyLbRule object. This represents active health monitoring over HTTP. Active healthchecks are initiated periodically, at a configurable interval, to each member of the Group. Only if a healthcheck fails consecutively for a specified number of times (fall_count) to a member will the member status be marked DOWN. Once a member is DOWN, a specified number of consecutive successful healthchecks (rise_count) will bring the member back to UP state. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.", 
  "extends": {
    "$ref": "PolicyLbMonitorProfile
  }, 
  "id": "HttpPolicyLbMonitorProfile", 
  "module_id": "TempPolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "HttpPolicyLbMonitorProfile"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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"
    }, 
    "fall_count": {
      "default": 3, 
      "description": "Only if a healthcheck fails consecutively for a specified number of times, given with fall_count, to a member will the member status be marked DOWN.", 
      "required": false, 
      "title": "Monitor fall count for active healthchecks", 
      "type": "integer"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "interval": {
      "default": 5, 
      "description": "Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group.", 
      "required": false, 
      "title": "Monitor interval in seconds for active healthchecks", 
      "type": "integer"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "monitor_port": {
      "description": "Typically, monitors perform healthchecks to Group members using the member IP address and pool_port. However, in some cases, customers prefer to run healthchecks against a different port than the pool member port which handles actual application traffic. In such cases, the port to run healthchecks against can be specified in the monitor_port value.", 
      "maximum": 65535, 
      "minimum": 0, 
      "required": false, 
      "title": "Monitor port for active healthchecks", 
      "type": "int"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": [
        "TcpPolicyLbMonitorProfile", 
        "UdpPolicyLbMonitorProfile", 
        "IcmpPolicyLbMonitorProfile", 
        "HttpPolicyLbMonitorProfile", 
        "HttpsPolicyLbMonitorProfile"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "rise_count": {
      "default": 3, 
      "description": "Once a member is DOWN, a specified number of consecutive successful healthchecks specified by rise_count will bring the member back to UP state.", 
      "required": false, 
      "title": "Monitor rise count for active healthchecks", 
      "type": "integer"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "timeout": {
      "default": 15, 
      "description": "Timeout specified in seconds.  After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.", 
      "required": false, 
      "title": "Monitor timeout in seconds for active healthchecks", 
      "type": "integer"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }, 
    "url": {
      "default": "/", 
      "description": "For HTTP active healthchecks, the HTTP request url sent can be customized and can include query parameters.", 
      "required": false, 
      "title": "Customized HTTP request url for active health checks", 
      "type": "string"
    }
  }, 
  "title": "PolicyLbMonitorProfile for active health checks over HTTP", 
  "type": "object"
}

HttpPolicyLbVirtualServer (type)

{
  "additionalProperties": false, 
  "description": "Virtual server acts as a facade to an application, receives all client connections over HTTP and distributes them among the backend servers.", 
  "extends": {
    "$ref": "PolicyLbVirtualServer
  }, 
  "id": "HttpPolicyLbVirtualServer", 
  "module_id": "TempPolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "HttpPolicyLbVirtualServer"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "access_log_enabled": {
      "default": false, 
      "description": "If access log is enabled, all HTTP requests sent to an L7 virtual server are logged to the access log file. Both successful requests (backend server returns 2xx) and unsuccessful requests (backend server returns 4xx or 5xx) are logged to access log, if enabled.", 
      "required": false, 
      "title": "Access log enabled setting", 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "insert_client_ip_header": {
      "default": false, 
      "description": "Backend web servers typically log each request they handle along with the requesting client IP address. These logs are used for debugging, analytics and other such purposes. If the deployment topology requires enabling SNAT on the load balancer, then server will see the client as the SNAT IP which defeats the purpose of logging. To work around this issue, load balancer can be configured to insert XFF HTTP header with the original client IP address. Backend servers can then be configured to log the IP address in XFF header instead of the source IP address of the connection. If XFF header is not present in the incoming request, load balancer inserts a new XFF header with the client IP address.", 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "boolean"
    }, 
    "ip_address": {
      "$ref": "IPAddress, 
      "description": "Configures the IP address of the PolicyLbVirtualServer where it receives all client connections and distributes them among the backend servers.", 
      "required": true, 
      "title": "IP address of the PolicyLbVirtualServer"
    }, 
    "lb_persistence_profile": {
      "description": "Path to optional object that enables persistence on a virtual server allowing related client connections to be sent to the same backend server. Persistence is disabled by default.", 
      "required": false, 
      "title": "Persistence Profile used by PolicyLbVirtualServer", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "ports": {
      "description": "Ports contains a list of at least one port or port range such as \"80\", \"1234-1236\". Each port element in the list should be a single port or a single port range.", 
      "items": {
        "$ref": "PortElement
      }, 
      "required": true, 
      "title": "Virtual server port number(s) or port range(s)", 
      "type": "array"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "enum": [
        "TcpPolicyLbVirtualServer", 
        "UdpPolicyLbVirtualServer", 
        "HttpPolicyLbVirtualServer", 
        "HttpsPolicyLbVirtualServer", 
        "CustomPolicyLbVirtualServer"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "router_path": {
      "description": "Path to router type object that PolicyLbVirtualServer connects to. The only supported router object is Network.", 
      "required": true, 
      "title": "Path to router type object for PolicyLbVirtualServer", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "traffic_source": {
      "type": "string"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "PolicyLbVirtualServer handling connections over HTTP", 
  "type": "object"
}

HttpProtocol (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Protocol
  }, 
  "id": "HttpProtocol", 
  "polymorphic-type-descriptor": {
    "type-identifier": "http"
  }, 
  "properties": {
    "authentication_scheme": {
      "$ref": "BasicAuthenticationScheme, 
      "title": "Scheme to authenticate if required"
    }, 
    "name": {
      "enum": [
        "http", 
        "https", 
        "scp", 
        "sftp"
      ], 
      "required": true, 
      "title": "Protocol name", 
      "type": "string"
    }
  }, 
  "type": "object"
}

HttpRequestMethodType (type)

{
  "additionalProperties": false, 
  "enum": [
    "GET", 
    "OPTIONS", 
    "POST", 
    "HEAD", 
    "PUT"
  ], 
  "id": "HttpRequestMethodType", 
  "module_id": "LoadBalancer", 
  "title": "http monitor method", 
  "type": "string"
}

HttpRequestVersionType (type)

{
  "additionalProperties": false, 
  "enum": [
    "HTTP_VERSION_1_0", 
    "HTTP_VERSION_1_1"
  ], 
  "id": "HttpRequestVersionType", 
  "module_id": "LoadBalancer", 
  "title": "http request version", 
  "type": "string"
}

HttpServiceProperties (type)

{
  "additionalProperties": false, 
  "id": "HttpServiceProperties", 
  "properties": {
    "basic_authentication_enabled": {
      "default": true, 
      "description": "Identifies whether basic authentication is enabled or disabled in API calls.", 
      "title": "Enable or disable basic authentication", 
      "type": "boolean"
    }, 
    "certificate": {
      "$ref": "Certificate, 
      "readonly": true, 
      "required": true
    }, 
    "cipher_suites": {
      "items": {
        "$ref": "CipherSuite
      }, 
      "minItems": 1, 
      "title": "Cipher suites used to secure contents of connection", 
      "type": "array"
    }, 
    "client_api_concurrency_limit": {
      "default": 40, 
      "description": "The maximum number of concurrent API requests that will be serviced for a given authenticated client.  If the number of API requests being processed exceeds this limit, new API requests will be refused and a 503 Service Unavailable response will be returned to the client. To disable API concurrency limiting, set this value to 0.", 
      "minimum": 0, 
      "title": "Client API rate limit in calls", 
      "type": "integer"
    }, 
    "client_api_rate_limit": {
      "default": 100, 
      "description": "The maximum number of API requests that will be serviced per second for a given authenticated client.  If more API requests are received than can be serviced, a 429 Too Many Requests HTTP response will be returned. To disable API rate limiting, set this value to 0.", 
      "minimum": 0, 
      "title": "Client API rate limit in calls per second", 
      "type": "integer"
    }, 
    "connection_timeout": {
      "maximum": 2147483647, 
      "minimum": 0, 
      "title": "NSX connection timeout, set to 0 to configure no timeout", 
      "type": "integer"
    }, 
    "cookie_based_authentication_enabled": {
      "default": true, 
      "description": "Identifies whether cookie-based authentication is enabled or disabled in API calls. When cookie-based authentication is disabled, new sessions cannot be created via /api/session/create.", 
      "title": "Enable or disable cookie-based authentication", 
      "type": "boolean"
    }, 
    "global_api_concurrency_limit": {
      "default": 100, 
      "description": "The maximum number of concurrent API requests that will be serviced. If the number of API requests being processed exceeds this limit, new API requests will be refused and a 503 Service Unavailable response will be returned to the client.  To disable API concurrency limiting, set this value to 0.", 
      "minimum": 0, 
      "title": "Global API rate limit in calls", 
      "type": "integer"
    }, 
    "logging_level": {
      "default": "INFO", 
      "enum": [
        "OFF", 
        "FATAL", 
        "ERROR", 
        "WARN", 
        "INFO", 
        "DEBUG", 
        "TRACE"
      ], 
      "required": false, 
      "title": "Service logging level", 
      "type": "string"
    }, 
    "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"
}

HttpsPolicyLbMonitorProfile (type)

{
  "additionalProperties": false, 
  "description": "Active healthchecks are disabled by default and can be enabled for a server pool by binding a health monitor to the Group through the PolicyLbRule object. This represents active health monitoring over HTTPS. Active healthchecks are initiated periodically, at a configurable interval, to each member of the Group. Only if a healthcheck fails consecutively for a specified number of times (fall_count) to a member will the member status be marked DOWN. Once a member is DOWN, a specified number of consecutive successful healthchecks (rise_count) will bring the member back to UP state. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.", 
  "extends": {
    "$ref": "HttpPolicyLbMonitorProfile
  }, 
  "id": "HttpsPolicyLbMonitorProfile", 
  "module_id": "TempPolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "HttpsPolicyLbMonitorProfile"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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"
    }, 
    "fall_count": {
      "default": 3, 
      "description": "Only if a healthcheck fails consecutively for a specified number of times, given with fall_count, to a member will the member status be marked DOWN.", 
      "required": false, 
      "title": "Monitor fall count for active healthchecks", 
      "type": "integer"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "interval": {
      "default": 5, 
      "description": "Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group.", 
      "required": false, 
      "title": "Monitor interval in seconds for active healthchecks", 
      "type": "integer"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "monitor_port": {
      "description": "Typically, monitors perform healthchecks to Group members using the member IP address and pool_port. However, in some cases, customers prefer to run healthchecks against a different port than the pool member port which handles actual application traffic. In such cases, the port to run healthchecks against can be specified in the monitor_port value.", 
      "maximum": 65535, 
      "minimum": 0, 
      "required": false, 
      "title": "Monitor port for active healthchecks", 
      "type": "int"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": [
        "TcpPolicyLbMonitorProfile", 
        "UdpPolicyLbMonitorProfile", 
        "IcmpPolicyLbMonitorProfile", 
        "HttpPolicyLbMonitorProfile", 
        "HttpsPolicyLbMonitorProfile"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "rise_count": {
      "default": 3, 
      "description": "Once a member is DOWN, a specified number of consecutive successful healthchecks specified by rise_count will bring the member back to UP state.", 
      "required": false, 
      "title": "Monitor rise count for active healthchecks", 
      "type": "integer"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "timeout": {
      "default": 15, 
      "description": "Timeout specified in seconds.  After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.", 
      "required": false, 
      "title": "Monitor timeout in seconds for active healthchecks", 
      "type": "integer"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }, 
    "url": {
      "default": "/", 
      "description": "For HTTP active healthchecks, the HTTP request url sent can be customized and can include query parameters.", 
      "required": false, 
      "title": "Customized HTTP request url for active health checks", 
      "type": "string"
    }
  }, 
  "title": "PolicyLbMonitorProfile for active health checks over HTTPS", 
  "type": "object"
}

HttpsPolicyLbVirtualServer (type)

{
  "additionalProperties": false, 
  "description": "Virtual server acts as a facade to an application, receives all client connections over HTTPS and distributes them among the backend servers.", 
  "extends": {
    "$ref": "HttpPolicyLbVirtualServer
  }, 
  "id": "HttpsPolicyLbVirtualServer", 
  "module_id": "TempPolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "HttpsPolicyLbVirtualServer"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "access_log_enabled": {
      "default": false, 
      "description": "If access log is enabled, all HTTP requests sent to an L7 virtual server are logged to the access log file. Both successful requests (backend server returns 2xx) and unsuccessful requests (backend server returns 4xx or 5xx) are logged to access log, if enabled.", 
      "required": false, 
      "title": "Access log enabled setting", 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "client_ssl_certificate_ids": {
      "description": "Client-side SSL profile binding allows multiple certificates, for different hostnames, to be bound to the same virtual server. The setting is used when load balancer acts as an SSL server and terminating the client SSL connection", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "ssl certificates", 
      "type": "array"
    }, 
    "client_ssl_settings": {
      "default": "HIGH_SECURE_111317", 
      "description": "Security settings representing various security settings when the VirtualServer acts as an SSL server - BASE_SECURE_111317 - MODERATE_SECURE_111317 - HIGH_SECURE_111317", 
      "enum": [
        "BASE_SECURE_111317", 
        "MODERATE_SECURE_111317", 
        "HIGH_SECURE_111317"
      ], 
      "required": false, 
      "title": "Security profile setting", 
      "type": "string"
    }, 
    "default_client_ssl_certificate_id": {
      "description": "The setting is used when load balancer acts as an SSL server and terminating the client SSL connection.  A default certificate should be specified which will be used if the server does not host multiple hostnames on the same IP address or if the client does not support SNI extension.", 
      "required": true, 
      "title": "ssl certificate", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "insert_client_ip_header": {
      "default": false, 
      "description": "Backend web servers typically log each request they handle along with the requesting client IP address. These logs are used for debugging, analytics and other such purposes. If the deployment topology requires enabling SNAT on the load balancer, then server will see the client as the SNAT IP which defeats the purpose of logging. To work around this issue, load balancer can be configured to insert XFF HTTP header with the original client IP address. Backend servers can then be configured to log the IP address in XFF header instead of the source IP address of the connection. If XFF header is not present in the incoming request, load balancer inserts a new XFF header with the client IP address.", 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "boolean"
    }, 
    "ip_address": {
      "$ref": "IPAddress, 
      "description": "Configures the IP address of the PolicyLbVirtualServer where it receives all client connections and distributes them among the backend servers.", 
      "required": true, 
      "title": "IP address of the PolicyLbVirtualServer"
    }, 
    "lb_persistence_profile": {
      "description": "Path to optional object that enables persistence on a virtual server allowing related client connections to be sent to the same backend server. Persistence is disabled by default.", 
      "required": false, 
      "title": "Persistence Profile used by PolicyLbVirtualServer", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "ports": {
      "description": "Ports contains a list of at least one port or port range such as \"80\", \"1234-1236\". Each port element in the list should be a single port or a single port range.", 
      "items": {
        "$ref": "PortElement
      }, 
      "required": true, 
      "title": "Virtual server port number(s) or port range(s)", 
      "type": "array"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "enum": [
        "TcpPolicyLbVirtualServer", 
        "UdpPolicyLbVirtualServer", 
        "HttpPolicyLbVirtualServer", 
        "HttpsPolicyLbVirtualServer", 
        "CustomPolicyLbVirtualServer"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "router_path": {
      "description": "Path to router type object that PolicyLbVirtualServer connects to. The only supported router object is Network.", 
      "required": true, 
      "title": "Path to router type object for PolicyLbVirtualServer", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "traffic_source": {
      "type": "string"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "PolicyLbVirtualServer handling connections over HTTPS", 
  "type": "object"
}

HttpsProtocol (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Protocol
  }, 
  "id": "HttpsProtocol", 
  "polymorphic-type-descriptor": {
    "type-identifier": "https"
  }, 
  "properties": {
    "authentication_scheme": {
      "$ref": "BasicAuthenticationScheme, 
      "title": "Scheme to authenticate if required"
    }, 
    "name": {
      "enum": [
        "http", 
        "https", 
        "scp", 
        "sftp"
      ], 
      "required": true, 
      "title": "Protocol name", 
      "type": "string"
    }, 
    "sha256_thumbprint": {
      "required": true, 
      "title": "SSL thumbprint of server", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ICMPTypeServiceEntry (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ServiceEntry
  }, 
  "id": "ICMPTypeServiceEntry", 
  "module_id": "Policy", 
  "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: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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"
    }, 
    "icmp_code": {
      "maximum": 255, 
      "minimum": 0, 
      "required": false, 
      "title": "ICMP message code", 
      "type": "integer"
    }, 
    "icmp_type": {
      "maximum": 255, 
      "minimum": 0, 
      "required": false, 
      "title": "ICMP message type", 
      "type": "integer"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": [
        "IPProtocolServiceEntry", 
        "IGMPTypeServiceEntry", 
        "ICMPTypeServiceEntry", 
        "ALGTypeServiceEntry", 
        "L4PortSetServiceEntry", 
        "EtherTypeServiceEntry", 
        "NestedServiceServiceEntry"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "A ServiceEntry that represents IPv4 or IPv6 ICMP protocol", 
  "type": "object"
}

IGMPTypeServiceEntry (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ServiceEntry
  }, 
  "id": "IGMPTypeServiceEntry", 
  "module_id": "Policy", 
  "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: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": [
        "IPProtocolServiceEntry", 
        "IGMPTypeServiceEntry", 
        "ICMPTypeServiceEntry", 
        "ALGTypeServiceEntry", 
        "L4PortSetServiceEntry", 
        "EtherTypeServiceEntry", 
        "NestedServiceServiceEntry"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "A ServiceEntry that represents IGMP protocol", 
  "type": "object"
}

IPAddress (type)

{
  "format": "ip", 
  "id": "IPAddress", 
  "module_id": "Common", 
  "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. Avoid creating groups with multiple IPAddressExpression. In future releases, group will be restricted to contain a single IPAddressExpression. To group IPAddresses, use nested groups instead of multiple IPAddressExpressions.", 
  "extends": {
    "$ref": "Expression
  }, 
  "id": "IPAddressExpression", 
  "module_id": "Policy", 
  "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: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "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
      }, 
      "maxItems": 4000, 
      "minItems": 1, 
      "required": true, 
      "title": "Array of IP addresses", 
      "type": "array"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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", 
        "ExternalIDExpression", 
        "PathExpression", 
        "IdentityGroupExpression"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "IP address expression node", 
  "type": "object"
}

IPAddressGroupAssociationRequestParams (type)

{
  "description": "List request parameters containing ip address and enforcement point path", 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "IPAddressGroupAssociationRequestParams", 
  "module_id": "PolicyGroupRealization", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "enforcement_point_path": {
      "description": "The path of the enforcement point from which the list of groups needs to be fetched. Forward slashes must be escaped using %2F. If no enforcement point path is specified, the default enforcement point is considered", 
      "required": false, 
      "title": "String Path of the enforcement point", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "ip_address": {
      "required": true, 
      "title": "IPAddress", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "List request parameters containing ip address and enforcement point path", 
  "type": "object"
}

IPAddressList (type)

{
  "additionalProperties": false, 
  "description": "Collection of IP Addresses.", 
  "id": "IPAddressList", 
  "module_id": "Policy", 
  "properties": {
    "ip_addresses": {
      "description": "The array contains IP addresses.", 
      "items": {
        "$ref": "IPElement
      }, 
      "maxItems": 4000, 
      "minItems": 1, 
      "required": true, 
      "title": "Array of IP addresses", 
      "type": "array"
    }
  }, 
  "title": "IP Address collection.", 
  "type": "object"
}

IPAddressPortPair (type)

{
  "additionalProperties": false, 
  "description": "IP Address and Port information", 
  "id": "IPAddressPortPair", 
  "module_id": "TempPolicyLoadBalancer", 
  "properties": {
    "ip_address": {
      "$ref": "IPAddress, 
      "description": "The IPAddress to be combined with Port for defining specific access point.", 
      "required": true, 
      "title": "IPAddress for IPAddressPort combination"
    }, 
    "port": {
      "description": "The port to be combined with IPAddress for defining a specific access point.", 
      "maximum": 65535, 
      "minimum": 0, 
      "title": "The port for IPAddressPort combination", 
      "type": "int"
    }
  }, 
  "title": "IP Address and Port information", 
  "type": "object"
}

IPCIDRBlock (type)

{
  "format": "ip-cidr-block", 
  "id": "IPCIDRBlock", 
  "module_id": "Common", 
  "title": "IPv4 or IPv6 CIDR Block", 
  "type": "string"
}

IPDiscoveryProfile (type)

{
  "additionalProperties": false, 
  "description": "Using this profile to configure different options of IP Discovery", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "IPDiscoveryProfile", 
  "module_id": "PolicyIpDiscovery", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "arp_nd_binding_timeout": {
      "default": 10, 
      "description": "This property controls the ARP and ND cache timeout period. It is recommended that this property be greater than the ARP/ND cache timeout on the VM.", 
      "maximum": 120, 
      "minimum": 5, 
      "required": false, 
      "title": "ARP and ND cache timeout (in minutes)", 
      "type": "int"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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"
    }, 
    "duplicate_ip_detection": {
      "$ref": "DuplicateIPDetectionOptions, 
      "description": "Duplicate IP detection is used to determine if there is any IP conflict with any other port on the same logical switch. If a conflict is detected, then the IP is marked as a duplicate on the port where the IP was discovered last. The duplicate IP will not be added to the realized address binings for the port and hence will not be used in DFW rules or other security configurations for the port.rt.", 
      "readonly": false, 
      "required": false, 
      "title": "Duplicate IP Dection Options"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ip_v4_discovery_options": {
      "$ref": "IPv4DiscoveryOptions, 
      "description": "Indicates IPv4 Discovery options", 
      "required": false, 
      "title": "IPv4 Discovery options"
    }, 
    "ip_v6_discovery_options": {
      "$ref": "IPv6DiscoveryOptions, 
      "description": "Indicates IPv6 Discovery options", 
      "required": false, 
      "title": "IPv6 Discovery options"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "tofu_enabled": {
      "default": true, 
      "description": "Indicates whether \"Trust on First Use(TOFU)\" paradigm is enabled.", 
      "required": false, 
      "title": "Is TOFU enabled or not", 
      "type": "boolean"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "search_dsl_name": [
    "ip discovery segment profile"
  ], 
  "title": "IP Discovery Profile", 
  "type": "object"
}

IPDiscoveryProfileListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "IPDiscoveryProfileListRequestParameters", 
  "module_id": "PolicyIpDiscovery", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "IP Discovery Profile request parameters", 
  "type": "object"
}

IPDiscoveryProfileListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "IPDiscoveryProfileListResult", 
  "module_id": "PolicyIpDiscovery", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "IPDiscoveryProfile
      }, 
      "required": true, 
      "title": "IP Discovery profile list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged collection of IP Discovery Profiles", 
  "type": "object"
}

IPElement (type)

{
  "description": "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\"", 
  "format": "address-or-block-or-range", 
  "id": "IPElement", 
  "module_id": "Common", 
  "title": "IP address, range, or subnet", 
  "type": "string"
}

IPElementList (type)

{
  "description": "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\"", 
  "format": "list-of-address-or-block-or-range", 
  "id": "IPElementList", 
  "module_id": "Common", 
  "title": "List of IP address, range, or subnet", 
  "type": "string"
}

IPFIXDFWCollector (type)

{
  "additionalProperties": false, 
  "description": "IPFIX DFW data will be collected on collector Host IP and Port address should be provided for collector.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "IPFIXDFWCollector", 
  "module_id": "PolicyIPFIXDFW", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "collector_ip_address": {
      "$ref": "IPAddress, 
      "description": "IP address for the IPFIX DFW collector. IP addresses such as 0.0.0.0, 127.0.0.1, 255.255.255.255 are invalid.", 
      "required": true, 
      "title": "IP address"
    }, 
    "collector_port": {
      "description": "Port for the IPFIX DFW collector.", 
      "required": true, 
      "title": "Port", 
      "type": "int"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "IPFIX DFW Collector", 
  "type": "object"
}

IPFIXDFWCollectorProfile (type)

{
  "additionalProperties": false, 
  "description": "IPFIX data for the NSX distributed firewall will be sent to the specified IPFIX collectors.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "IPFIXDFWCollectorProfile", 
  "module_id": "PolicyIPFIXDFW", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ipfix_dfw_collectors": {
      "description": "It accepts Multiple Collectors.", 
      "items": {
        "$ref": "IPFIXDFWCollector
      }, 
      "minItems": 1, 
      "required": true, 
      "title": "IPFIX DFW Collectors.", 
      "type": "array"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "IPFIX DFW Collector Profile", 
  "type": "object"
}

IPFIXDFWCollectorProfileListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "IPFIXDFWCollectorProfileListRequestParameters", 
  "module_id": "PolicyIPFIXDFW", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "IPFIX DFW Collector Profile request parameters", 
  "type": "object"
}

IPFIXDFWCollectorProfileListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "IPFIXDFWCollectorProfileListResult", 
  "module_id": "PolicyIPFIXDFW", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "IPFIXDFWCollectorProfile
      }, 
      "required": true, 
      "title": "IPFIX DFW Collection Instances list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of IPFIX DFW Collector Profile", 
  "type": "object"
}

IPFIXDFWProfile (type)

{
  "additionalProperties": false, 
  "description": "IPFIX packets from source will be sent to IPFIX DFW collector.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "IPFIXDFWProfile", 
  "module_id": "PolicyIPFIXDFW", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "active_flow_export_timeout": {
      "default": 1, 
      "description": "For long standing active flows, IPFIX records will be sent per timeout period in minutes.", 
      "maximum": 60, 
      "minimum": 1, 
      "required": true, 
      "title": "Active timeout (Minutes)", 
      "type": "int"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ipfix_dfw_collector_profile_path": {
      "description": "Policy path for IPFIX collector profiles. IPFIX data from these logical segments will be sent to all specified IPFIX collectors.", 
      "required": true, 
      "title": "IPFIX collector Paths", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "observation_domain_id": {
      "default": 0, 
      "description": "An identifier that is unique to the exporting process and used to meter the flows.", 
      "maximum": 65536, 
      "minimum": 0, 
      "required": false, 
      "title": "Observation domain ID", 
      "type": "int"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "priority": {
      "default": 0, 
      "description": "This priority field is used to resolve conflicts in Segment Ports which are covered by more than one IPFIX profiles. The IPFIX exporter will send records to Collectors in highest priority profile (lowest number) only.", 
      "maximum": 32000, 
      "minimum": 0, 
      "required": false, 
      "title": "Config Priority", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "IPFIX DFW Profile", 
  "type": "object"
}

IPFIXDFWProfileListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "IPFIXDFWProfileListRequestParameters", 
  "module_id": "PolicyIPFIXDFW", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "IPFIX DFW Profile request parameters", 
  "type": "object"
}

IPFIXDFWProfileListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "IPFIXDFWProfileListResult", 
  "module_id": "PolicyIPFIXDFW", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "IPFIXDFWProfile
      }, 
      "required": true, 
      "title": "IPFIX DFW Profile list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of IPFIX DFW Profile", 
  "type": "object"
}

IPFIXL2Collector (type)

{
  "additionalProperties": false, 
  "description": "IPFIX packets will be collected on collector. IP and port address should be provided for collector.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "IPFIXL2Collector", 
  "module_id": "PolicyIPFIXSwitch", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "collector_ip_address": {
      "$ref": "IPAddress, 
      "description": "IP address for the IPFIX L2 collector. IP addresses such as 0.0.0.0, 127.0.0.1, 255.255.255.255 are invalid.", 
      "required": true, 
      "title": "IP address"
    }, 
    "collector_port": {
      "default": 4739, 
      "description": "Port number for the IPFIX L2 collector.", 
      "maximum": 65535, 
      "minimum": 0, 
      "title": "Port", 
      "type": "int"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "IPFIX L2 Collector", 
  "type": "object"
}

IPFIXL2CollectorProfile (type)

{
  "additionalProperties": false, 
  "description": "IPFIX L2 data will be collected on collectors.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "IPFIXL2CollectorProfile", 
  "module_id": "PolicyIPFIXSwitch", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ipfix_l2_collectors": {
      "description": "It accepts Multiple Collector objects.", 
      "items": {
        "$ref": "IPFIXL2Collector
      }, 
      "maxItems": 4, 
      "minItems": 1, 
      "required": true, 
      "title": "It accepts Multiple Collector objects.", 
      "type": "array"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "IPFIX L2 Collector Profile", 
  "type": "object"
}

IPFIXL2CollectorProfileListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "IPFIXL2CollectorProfileListRequestParameters", 
  "module_id": "PolicyIPFIXSwitch", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "IPFIX collector profile request parameters", 
  "type": "object"
}

IPFIXL2CollectorProfileListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "IPFIXL2CollectorProfileListResult", 
  "module_id": "PolicyIPFIXSwitch", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "IPFIXL2CollectorProfile
      }, 
      "required": true, 
      "title": "IPFIX collector Profile list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged list of IPFIX collector profiles.", 
  "type": "object"
}

IPFIXL2Profile (type)

{
  "additionalProperties": false, 
  "description": "IPFIX data from source logical segment, port, group will be forwarded to IPFIX collector.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "IPFIXL2Profile", 
  "module_id": "PolicyIPFIXSwitch", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "active_timeout": {
      "default": 300, 
      "description": "The time in seconds after a flow is expired even if more packets matching this flow are received by the cache.", 
      "maximum": 3600, 
      "minimum": 60, 
      "title": "Active timeout", 
      "type": "int"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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"
    }, 
    "export_overlay_flow": {
      "default": true, 
      "description": "This property controls whether overlay flow info is included in the sample result.", 
      "required": false, 
      "title": "Export overlay Flow", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "idle_timeout": {
      "default": 300, 
      "description": "The time in seconds after a flow is expired if no more packets matching this flow are received by the cache.", 
      "maximum": 3600, 
      "minimum": 60, 
      "required": false, 
      "title": "Idle timeout", 
      "type": "int"
    }, 
    "ipfix_collector_profile_path": {
      "description": "Policy path for IPFIX collector profile. User can specify only one IPFIX collector.", 
      "required": true, 
      "title": "IPFIX collector Path", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "max_flows": {
      "default": 16384, 
      "description": "The maximum number of flow entries in each exporter flow cache.", 
      "maximum": 4294967295, 
      "minimum": 0, 
      "required": false, 
      "title": "Max flows", 
      "type": "integer"
    }, 
    "observation_domain_id": {
      "default": 0, 
      "description": "An identifier that is unique to the exporting process and used to meter the flows.", 
      "maximum": 4294967295, 
      "minimum": 0, 
      "required": false, 
      "title": "Observation domain ID", 
      "type": "integer"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "packet_sample_probability": {
      "default": 0.1, 
      "description": "The probability in percentage that a packet is sampled, in range 0-100. The probability is equal for every packet.", 
      "exclusiveMinimum": true, 
      "maximum": 100, 
      "minimum": 0, 
      "required": true, 
      "title": "Packet sample probability", 
      "type": "number"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "priority": {
      "default": 0, 
      "description": "This priority field is used to resolve conflicts in Segment Ports which are covered by more than one IPFIX profiles. The IPFIX exporter will send records to Collectors in highest priority profile (lowest number) only.", 
      "maximum": 32000, 
      "minimum": 0, 
      "required": false, 
      "title": "Config Priority", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "IPFIX L2 Profile", 
  "type": "object"
}

IPFIXL2ProfileListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "IPFIXL2ProfileListRequestParameters", 
  "module_id": "PolicyIPFIXSwitch", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "IPFIX L2 Profile request parameters", 
  "type": "object"
}

IPFIXL2ProfileListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "IPFIXL2ProfileListResult", 
  "module_id": "PolicyIPFIXSwitch", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "IPFIXL2Profile
      }, 
      "required": true, 
      "title": "IPFIX L2 Profile list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of IPFIX L2 Profile", 
  "type": "object"
}

IPInfo (type)

{
  "id": "IPInfo", 
  "module_id": "ServiceInsertionCommonTypes", 
  "properties": {
    "ip_addresses": {
      "items": {
        "$ref": "IPv4Address
      }, 
      "maxItems": 1, 
      "minItems": 1, 
      "required": true, 
      "title": "IPv4 Addresses", 
      "type": "array"
    }, 
    "prefix_length": {
      "maximum": 32, 
      "minimum": 1, 
      "required": true, 
      "title": "Subnet Prefix Length", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

IPProtocolServiceEntry (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ServiceEntry
  }, 
  "id": "IPProtocolServiceEntry", 
  "module_id": "Policy", 
  "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: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "protocol_number": {
      "maximum": 255, 
      "minimum": 0, 
      "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": [
        "IPProtocolServiceEntry", 
        "IGMPTypeServiceEntry", 
        "ICMPTypeServiceEntry", 
        "ALGTypeServiceEntry", 
        "L4PortSetServiceEntry", 
        "EtherTypeServiceEntry", 
        "NestedServiceServiceEntry"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "A ServiceEntry that represents an IP protocol", 
  "type": "object"
}

IPSecDigestAlgorithm (type)

{
  "additionalProperties": false, 
  "description": "The IPSecDigestAlgorithms are used to verify message integrity during IPSec VPN tunnel establishment. SHA1 produces 160 bits hash and SHA2_XXX produces XXX bit hash.", 
  "enum": [
    "SHA1", 
    "SHA2_256", 
    "SHA2_384", 
    "SHA2_512"
  ], 
  "id": "IPSecDigestAlgorithm", 
  "module_id": "PolicyIPSecVpn", 
  "title": "Digest Algorithms used in IPSec tunnel establishment", 
  "type": "string"
}

IPSecEncryptionAlgorithm (type)

{
  "additionalProperties": false, 
  "description": "IPSecEncryptionAlgorithms are used to ensure confidentiality of the messages exchanged during Tunnel negotiations. AES stands for Advanced Encryption Standards. AES_128 uses 128-bit keys whereas AES_256 uses 256-bit keys for encryption and decryption. AES_GCM stands for Advanced Encryption Standard(AES) in Galois/Counter Mode (GCM) and is used to provide both confidentiality and data origin authentication. NO_ENCRYPTION_AUTH_AES_GMAC_* enables authentication on input data without encyption. Digest algorithm should be empty for this option.", 
  "enum": [
    "AES_128", 
    "AES_256", 
    "AES_GCM_128", 
    "AES_GCM_192", 
    "AES_GCM_256", 
    "NO_ENCRYPTION_AUTH_AES_GMAC_128", 
    "NO_ENCRYPTION_AUTH_AES_GMAC_192", 
    "NO_ENCRYPTION_AUTH_AES_GMAC_256", 
    "NO_ENCRYPTION"
  ], 
  "id": "IPSecEncryptionAlgorithm", 
  "module_id": "PolicyIPSecVpn", 
  "title": "Encryption algorithm used in IPSec tunnel", 
  "type": "string"
}

IPSecVpnDpdProfile (type)

{
  "additionalProperties": false, 
  "description": "Dead peer detection (DPD) is a method that allows detection of unreachable internet key excahnge (IKE) peers. Any changes affects all IPSec VPN sessions consuming this profile.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "IPSecVpnDpdProfile", 
  "module_id": "PolicyIPSecVpn", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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"
    }, 
    "dpd_probe_interval": {
      "description": "DPD probe interval defines an interval for DPD probes (in seconds). - When the DPD probe mode is periodic, this interval is the number of seconds between DPD messages. - When the DPD probe mode is on-demand, this interval is the number of seconds during which traffic is not received from the peer before DPD retry messages are sent if there is IPSec traffic to send. For PERIODIC Mode:  Minimum: 3  Maximum: 360  Default: 60 For ON_DEMAND Mode:  Minimum: 1  Maximum: 10  Default: 3", 
      "title": "DPD Probe Interval", 
      "type": "integer"
    }, 
    "dpd_probe_mode": {
      "default": "PERIODIC", 
      "description": "DPD probe mode is used to query the liveliness of the peer. Two modes are possible: - PERIODIC: is used to query the liveliness of the peer at regular intervals (dpd_probe_interval). It does not take into consideration traffic coming from the peer. The benefit of this mode over the on-demand mode is earlier detection of dead peers. However, use of periodic DPD incurs extra overhead. When communicating to large numbers of peers, please consider using on-demand DPD instead. - ON_DEMAND: is used to query the liveliness of the peer by instructing the local endpoint to send DPD message to a peer if there is traffic to send to the peer AND the peer was idle for dpd_probe_interval seconds (i.e. there was no traffic from the peer for dpd_probe_interval seconds).", 
      "enum": [
        "PERIODIC", 
        "ON_DEMAND"
      ], 
      "title": "DPD Probe Mode", 
      "type": "string"
    }, 
    "enabled": {
      "default": true, 
      "description": "If true, enable dead peer detection.", 
      "title": "Enable dead peer detection (DPD)", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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"
    }, 
    "retry_count": {
      "default": 10, 
      "description": "Maximum number of DPD messages' retry attempts. This value is applicable for both dpd probe modes, periodic and on-demand.", 
      "maximum": 100, 
      "minimum": 1, 
      "title": "Retry Count", 
      "type": "integer"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Dead peer detection (DPD) profile", 
  "type": "object"
}

IPSecVpnIkeProfile (type)

{
  "additionalProperties": false, 
  "description": "IKE Profile is a reusable profile that captures IKE phase one negotiation parameters. Any changes affects all IPSec VPN sessions consuming this profile.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "IPSecVpnIkeProfile", 
  "module_id": "PolicyIPSecVpn", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "dh_groups": {
      "description": "Diffie-Hellman group to be used if PFS is enabled. Default is GROUP14.", 
      "items": {
        "$ref": "DhGroup
      }, 
      "title": "DH group", 
      "type": "array"
    }, 
    "digest_algorithms": {
      "description": "Algorithm to be used for message digest during Internet Key Exchange(IKE) negotiation. Default is SHA2_256.", 
      "items": {
        "$ref": "IkeDigestAlgorithm
      }, 
      "title": "Algorithm for message hash", 
      "type": "array"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "encryption_algorithms": {
      "description": "Encryption algorithm is used during Internet Key Exchange(IKE) negotiation. Default is AES_128.", 
      "items": {
        "$ref": "IkeEncryptionAlgorithm
      }, 
      "title": "Encryption algorithm for IKE", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ike_version": {
      "default": "IKE_V2", 
      "description": "IKE protocol version to be used. IKE-Flex will initiate IKE-V2 and responds to both IKE-V1 and IKE-V2.", 
      "enum": [
        "IKE_V1", 
        "IKE_V2", 
        "IKE_FLEX"
      ], 
      "title": "IKE version", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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"
    }, 
    "sa_life_time": {
      "default": 86400, 
      "description": "Life time for security association. Default is 86400 seconds (1 day).", 
      "maximum": 31536000, 
      "minimum": 21600, 
      "title": "Security association (SA) life time", 
      "type": "integer"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Internet key exchange (IKE) profile", 
  "type": "object"
}

IPSecVpnLocalEndpoint (type)

{
  "additionalProperties": false, 
  "description": "Local endpoint represents a tier-0/tier-1 on which tunnel needs to be terminated.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "IPSecVpnLocalEndpoint", 
  "module_id": "PolicyIPSecVpn", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "certificate_path": {
      "description": "Policy path referencing site certificate.", 
      "title": "Certificate path", 
      "type": "string"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "local_address": {
      "$ref": "IPv4Address, 
      "description": "IPV4 Address of local endpoint.", 
      "required": true, 
      "title": "IPV4 Address of local endpoint"
    }, 
    "local_id": {
      "description": "Local identifier.", 
      "title": "Local identifier", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "trust_ca_paths": {
      "description": "List of policy paths referencing certificate authority (CA) to verify peer certificates.", 
      "items": {
        "type": "string"
      }, 
      "title": "Certificate authority (CA) paths", 
      "type": "array"
    }, 
    "trust_crl_paths": {
      "description": "List of policy paths referencing certificate revocation list (CRL) to peer certificates.", 
      "items": {
        "type": "string"
      }, 
      "title": "Certificate revocation list (CRL) paths", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "IPSec VPN Local Endpoint", 
  "type": "object"
}

IPSecVpnRule (type)

{
  "additionalProperties": false, 
  "description": "For policy-based IPsec VPNs, a security policy specifies as its action the VPN tunnel to be used for transit traffic that meets the policy\u2019s match criteria.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "IPSecVpnRule", 
  "module_id": "PolicyIPSecVpn", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "action": {
      "default": "PROTECT", 
      "description": "PROTECT - Protect rules are defined per policy based IPSec VPN session. BYPASS - Bypass rules are defined per IPSec VPN service and affects all policy based IPSec VPN sessions. Bypass rules are prioritized over protect rules.", 
      "enum": [
        "PROTECT", 
        "BYPASS"
      ], 
      "readonly": true, 
      "title": "Action to be applied", 
      "type": "string"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "destinations": {
      "description": "List of peer subnets. Specifying no value is interpreted as 0.0.0.0/0.", 
      "items": {
        "$ref": "IPSecVpnSubnet
      }, 
      "maxItems": 128, 
      "required": false, 
      "title": "Destination list", 
      "type": "array"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "enabled": {
      "default": true, 
      "description": "A flag to enable/disable the rule.", 
      "title": "Enabled flag", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "logged": {
      "default": false, 
      "description": "A flag to enable/disable the logging for the rule.", 
      "title": "Logging flag", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": "A sequence number is used to give a priority to an IPSecVpnRule.", 
      "minimum": 0, 
      "required": false, 
      "title": "Sequence number of the IPSecVpnRule", 
      "type": "int"
    }, 
    "sources": {
      "description": "List of local subnets. Specifying no value is interpreted as 0.0.0.0/0.", 
      "items": {
        "$ref": "IPSecVpnSubnet
      }, 
      "maxItems": 128, 
      "required": false, 
      "title": "Source list", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "IPSec VPN Rule", 
  "type": "object"
}

IPSecVpnService (type)

{
  "additionalProperties": false, 
  "description": "Create and manage IPSec VPN service for given locale service.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "IPSecVpnService", 
  "module_id": "PolicyIPSecVpn", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "bypass_rules": {
      "description": "Bypass policy rules are configured using VPN service. Bypass rules always have higher priority over protect rules and they affect all policy based vpn sessions associated with the IPSec VPN service. Protect rules are defined per policy based vpn session.", 
      "items": {
        "$ref": "IPSecVpnRule
      }, 
      "required": false, 
      "title": "Bypass Policy rules", 
      "type": "array"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "enabled": {
      "default": true, 
      "description": "If true, enable VPN services for given locale service.", 
      "title": "Enable virtual private network (VPN) service", 
      "type": "boolean"
    }, 
    "ha_sync": {
      "default": true, 
      "description": "Enable/disable IPSec HA state sync. IPSec HA state sync can be disabled if in case there are performance issues w.r.t. the state sync messages.", 
      "title": "Flag to enable IPSec HA State Sync", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ike_log_level": {
      "default": "INFO", 
      "description": "Log level for internet key exchange (IKE).", 
      "enum": [
        "DEBUG", 
        "INFO", 
        "WARN", 
        "ERROR", 
        "EMERGENCY"
      ], 
      "title": "Internet key exchange (IKE) log level", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "IPSec VPN service", 
  "type": "object"
}

IPSecVpnSession (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "description": "VPN session defines connection between local and peer endpoint. Until VPN session is defined configuration is not realized.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "IPSecVpnSession", 
  "module_id": "PolicyIPSecVpn", 
  "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: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "authentication_mode": {
      "default": "PSK", 
      "description": "Peer authentication mode. PSK - In this mode a secret key shared between local and peer sites is to be used for authentication. The secret key can be a string with a maximum length of 128 characters. CERTIFICATE - In this mode a certificate defined at the global level is to be used for authentication.", 
      "enum": [
        "PSK", 
        "CERTIFICATE"
      ], 
      "title": "Authentication Mode", 
      "type": "string"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "compliance_suite": {
      "description": "Compliance suite.", 
      "enum": [
        "CNSA", 
        "SUITE_B_GCM_128", 
        "SUITE_B_GCM_256", 
        "PRIME", 
        "FOUNDATION", 
        "FIPS", 
        "NONE"
      ], 
      "title": "Compliance suite", 
      "type": "string"
    }, 
    "connection_initiation_mode": {
      "default": "INITIATOR", 
      "description": "Connection initiation mode used by local endpoint to establish ike connection with peer site. INITIATOR - In this mode local endpoint initiates tunnel setup and will also respond to incoming tunnel setup requests from peer gateway. RESPOND_ONLY - In this mode, local endpoint shall only respond to incoming tunnel setup requests. It shall not initiate the tunnel setup. ON_DEMAND - In this mode local endpoint will initiate tunnel creation once first packet matching the policy rule is received and will also respond to incoming initiation request.", 
      "enum": [
        "INITIATOR", 
        "RESPOND_ONLY", 
        "ON_DEMAND"
      ], 
      "title": "Connection initiation mode", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "dpd_profile_path": {
      "description": "Policy path referencing Dead Peer Detection (DPD) profile. Default is set to system default profile.", 
      "title": "Dead peer detection (DPD) profile path", 
      "type": "string"
    }, 
    "enabled": {
      "default": true, 
      "description": "Enable/Disable IPSec VPN session.", 
      "title": "Enable/Disable IPSec VPN session", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ike_profile_path": {
      "description": "Policy path referencing IKE profile to be used. Default is set according to system default profile.", 
      "title": "Internet key exchange (IKE) profile path", 
      "type": "string"
    }, 
    "local_endpoint_path": {
      "description": "Policy path referencing Local endpoint.", 
      "required": true, 
      "title": "Local endpoint path", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "peer_address": {
      "description": "Public IPV4 address of the remote device terminating the VPN connection.", 
      "required": true, 
      "title": "IPV4 address of peer endpoint on remote site", 
      "type": "string"
    }, 
    "peer_id": {
      "description": "Peer ID to uniquely identify the peer site. The peer ID is the public IP address of the remote device terminating the VPN tunnel. When NAT is configured for the peer, enter the private IP address of the peer.", 
      "required": true, 
      "title": "Peer id", 
      "type": "string"
    }, 
    "psk": {
      "description": "IPSec Pre-shared key. Maximum length of this field is 128 characters.", 
      "sensitive": true, 
      "title": "Pre-shared key", 
      "type": "string"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "$ref": "IPSecVpnSessionResourceType, 
      "required": true
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "tcp_mss_clamping": {
      "$ref": "TcpMaximumSegmentSizeClamping, 
      "description": "TCP Maximum Segment Size Clamping Direction and Value.", 
      "title": "TCP MSS Clamping"
    }, 
    "tunnel_profile_path": {
      "description": "Policy path referencing Tunnel profile to be used. Default is set to system default profile.", 
      "title": "IPSec tunnel profile path", 
      "type": "string"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "IPSec VPN session", 
  "type": "object"
}

IPSecVpnSessionResourceType (type)

{
  "additionalProperties": false, 
  "description": "A Policy Based VPN requires to define protect rules that match   local and peer subnets. IPSec security associations is   negotiated for each pair of local and peer subnet. A Route Based VPN is more flexible, more powerful and recommended over   policy based VPN. IP Tunnel port is created and all traffic routed via   tunnel port is protected. Routes can be configured statically   or can be learned through BGP. A route based VPN is must for establishing   redundant VPN session to remote site.", 
  "enum": [
    "PolicyBasedIPSecVpnSession", 
    "RouteBasedIPSecVpnSession"
  ], 
  "id": "IPSecVpnSessionResourceType", 
  "module_id": "PolicyIPSecVpn", 
  "title": "Resource types of IPsec VPN session", 
  "type": "string"
}

IPSecVpnSubnet (type)

{
  "additionalProperties": false, 
  "description": "Used to specify the local/peer subnets in IPSec VPN rule.", 
  "id": "IPSecVpnSubnet", 
  "module_id": "PolicyIPSecVpn", 
  "properties": {
    "subnet": {
      "$ref": "IPv4CIDRBlock, 
      "description": "Subnet used in policy rule.", 
      "required": true, 
      "title": "Peer or local subnet"
    }
  }, 
  "title": "Subnet for IPSec Policy based VPN", 
  "type": "object"
}

IPSecVpnTunnelInterface (type)

{
  "additionalProperties": false, 
  "description": "IP tunnel interface configuration.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "IPSecVpnTunnelInterface", 
  "module_id": "PolicyIPSecVpn", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ip_subnets": {
      "description": "IP Tunnel interface (commonly referred as VTI) subnet.", 
      "items": {
        "$ref": "TunnelInterfaceIPSubnet
      }, 
      "maxItems": 1, 
      "minItems": 1, 
      "required": true, 
      "title": "IP Tunnel interface subnet", 
      "type": "array"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "IP tunnel interface configuration", 
  "type": "object"
}

IPSecVpnTunnelProfile (type)

{
  "additionalProperties": false, 
  "description": "IPSec VPN tunnel profile is a reusable profile that captures phase two negotiation parameters and IPSec tunnel properties. Any changes affects all IPSec VPN sessions consuming this profile.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "IPSecVpnTunnelProfile", 
  "module_id": "PolicyIPSecVpn", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "df_policy": {
      "default": "COPY", 
      "description": "Defragmentation policy helps to handle defragmentation bit present in the inner packet. COPY copies the defragmentation bit from the inner IP packet into the outer packet. CLEAR ignores the defragmentation bit present in the inner packet.", 
      "enum": [
        "COPY", 
        "CLEAR"
      ], 
      "title": "Policy for handling defragmentation bit", 
      "type": "string"
    }, 
    "dh_groups": {
      "description": "Diffie-Hellman group to be used if PFS is enabled. Default is GROUP14.", 
      "items": {
        "$ref": "DhGroup
      }, 
      "title": "Dh group", 
      "type": "array"
    }, 
    "digest_algorithms": {
      "description": "Algorithm to be used for message digest. Default digest algorithm is implicitly covered by default encryption algorithm \"AES_GCM_128\".", 
      "items": {
        "$ref": "IPSecDigestAlgorithm
      }, 
      "title": "Algorithm for message hash", 
      "type": "array"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "enable_perfect_forward_secrecy": {
      "default": true, 
      "description": "If true, perfect forward secrecy (PFS) is enabled.", 
      "title": "Enable perfect forward secrecy", 
      "type": "boolean"
    }, 
    "encryption_algorithms": {
      "description": "Encryption algorithm to encrypt/decrypt the messages exchanged between IPSec VPN initiator and responder during tunnel negotiation. Default is AES_GCM_128.", 
      "items": {
        "$ref": "IPSecEncryptionAlgorithm
      }, 
      "title": "Encryption algorithm to use in IPSec tunnel establishement", 
      "type": "array"
    }, 
    "extended_attributes": {
      "description": "Collection of type specific properties. As of now, to hold encapsulation mode and transform protocol.", 
      "items": {
        "$ref": "AttributeVal
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Extended Attributes.", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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"
    }, 
    "sa_life_time": {
      "default": 3600, 
      "description": "SA life time specifies the expiry time of security association. Default is 3600 seconds.", 
      "maximum": 31536000, 
      "minimum": 900, 
      "title": "Security association (SA) life time", 
      "type": "integer"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "IPSec VPN tunnel profile", 
  "type": "object"
}

IPv4Address (type)

{
  "format": "ipv4", 
  "id": "IPv4Address", 
  "module_id": "Common", 
  "title": "IPv4 address", 
  "type": "string"
}

IPv4AddressProperties (type)

{
  "additionalProperties": false, 
  "id": "IPv4AddressProperties", 
  "properties": {
    "ip_address": {
      "pattern": "^[\\d]{1,3}\\.[\\d]{1,3}\\.[\\d]{1,3}\\.[\\d]{1,3}$", 
      "title": "Interface IPv4 address", 
      "type": "string"
    }, 
    "netmask": {
      "pattern": "^[\\d]{1,3}\\.[\\d]{1,3}\\.[\\d]{1,3}\\.[\\d]{1,3}$", 
      "title": "Interface netmask", 
      "type": "string"
    }
  }, 
  "title": "IPv4 address properties", 
  "type": "object"
}

IPv4CIDRBlock (type)

{
  "format": "ipv4-cidr-block", 
  "id": "IPv4CIDRBlock", 
  "module_id": "Common", 
  "title": "IPv4 CIDR Block", 
  "type": "string"
}

IPv4DiscoveryOptions (type)

{
  "additionalProperties": false, 
  "description": "Contains IPv4 related discovery options.", 
  "id": "IPv4DiscoveryOptions", 
  "module_id": "PolicyIpDiscovery", 
  "properties": {
    "arp_snooping_config": {
      "$ref": "ArpSnoopingConfig, 
      "description": "Indicates ARP snooping options", 
      "required": false, 
      "title": "ARP snooping configuration"
    }, 
    "dhcp_snooping_enabled": {
      "default": true, 
      "description": "Indicates whether DHCP snooping is enabled", 
      "required": false, 
      "title": "Is DHCP snooping enabled or not", 
      "type": "boolean"
    }, 
    "vmtools_enabled": {
      "default": true, 
      "description": "Indicates whether fetching IP using vm-tools is enabled. This option is only supported on ESX where vm-tools is installed.", 
      "required": false, 
      "title": "Is VM tools enabled or not", 
      "type": "boolean"
    }
  }, 
  "title": "IPv4 discovery options", 
  "type": "object"
}

IPv6Address (type)

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

IPv6DADStatus (type)

{
  "additionalProperties": false, 
  "id": "IPv6DADStatus", 
  "module_id": "LogicalRouterPorts", 
  "properties": {
    "ip_address": {
      "$ref": "IPAddress, 
      "description": "IP address on the port for which DAD status is reported.", 
      "readonly": true, 
      "required": false, 
      "title": "IP address"
    }, 
    "status": {
      "$ref": "DADStatus, 
      "description": "DAD status for IP address on the port.", 
      "readonly": true, 
      "required": false, 
      "title": "DAD Status"
    }, 
    "transport_node": {
      "description": "Array of transport node id on which DAD status is reported for given IP address.", 
      "items": {
        "$ref": "ResourceReference
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Transport node", 
      "type": "array"
    }
  }, 
  "title": "IPv6 DAD status", 
  "type": "object"
}

IPv6DiscoveryOptions (type)

{
  "additionalProperties": false, 
  "description": "Contains IPv6 related discovery options.", 
  "id": "IPv6DiscoveryOptions", 
  "module_id": "PolicyIpDiscovery", 
  "properties": {
    "dhcp_snooping_v6_enabled": {
      "default": false, 
      "description": "Enable this method will snoop the DHCPv6 message transaction which a VM makes with a DHCPv6 server. From the transaction, we learn the IPv6 addresses assigned by the DHCPv6 server to this VM along with its lease time.", 
      "required": false, 
      "title": "Is DHCP snoping v6 enabled or not", 
      "type": "boolean"
    }, 
    "nd_snooping_config": {
      "$ref": "NdSnoopingConfig, 
      "description": "Indicates ND snooping options", 
      "required": false, 
      "title": "ND snooping configuration"
    }, 
    "vmtools_v6_enabled": {
      "default": false, 
      "description": "Enable this method will learn the IPv6 addresses which are configured on interfaces of a VM with the help of the VMTools software.", 
      "required": false, 
      "type": "boolean"
    }
  }, 
  "title": "IPv6 discovery options", 
  "type": "object"
}

IPv6Status (type)

{
  "additionalProperties": false, 
  "id": "IPv6Status", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "connected_segment_path": {
      "description": "Path of the segment attached to the interface.", 
      "readonly": true, 
      "required": false, 
      "title": "Connected segment path", 
      "type": "string"
    }, 
    "dad_statuses": {
      "description": "Array of DAD status which contains DAD information for IP addresses on the interface.", 
      "items": {
        "$ref": "IPv6DADStatus
      }, 
      "readonly": true, 
      "title": "IPv6 DAD status", 
      "type": "array"
    }, 
    "interface_id": {
      "description": "Policy path or realization ID of interface for which IPv6 DAD status is returned.", 
      "title": "Policy path or realization ID of interface", 
      "type": "string"
    }
  }, 
  "title": "IPv6 status", 
  "type": "object"
}

IcmpEchoRequestHeader (type)

{
  "additionalProperties": false, 
  "id": "IcmpEchoRequestHeader", 
  "module_id": "Traceflow", 
  "properties": {
    "id": {
      "default": 0, 
      "maximum": 65535, 
      "minimum": 0, 
      "required": false, 
      "title": "ICMP id", 
      "type": "integer"
    }, 
    "sequence": {
      "default": 0, 
      "maximum": 65535, 
      "minimum": 0, 
      "required": false, 
      "title": "ICMP sequence number", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

IcmpPolicyLbMonitorProfile (type)

{
  "additionalProperties": false, 
  "description": "Active healthchecks are disabled by default and can be enabled for a server pool by binding a health monitor to the Group through the PolicyLbRule object. This represents active health monitoring over ICMP. Active healthchecks are initiated periodically, at a configurable interval, to each member of the Group. Only if a healthcheck fails consecutively for a specified number of times (fall_count) to a member will the member status be marked DOWN. Once a member is DOWN, a specified number of consecutive successful healt hchecks (rise_count) will bring the member back to UP state. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.", 
  "extends": {
    "$ref": "PolicyLbMonitorProfile
  }, 
  "id": "IcmpPolicyLbMonitorProfile", 
  "module_id": "TempPolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "IcmpPolicyLbMonitorProfile"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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"
    }, 
    "fall_count": {
      "default": 3, 
      "description": "Only if a healthcheck fails consecutively for a specified number of times, given with fall_count, to a member will the member status be marked DOWN.", 
      "required": false, 
      "title": "Monitor fall count for active healthchecks", 
      "type": "integer"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "interval": {
      "default": 5, 
      "description": "Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group.", 
      "required": false, 
      "title": "Monitor interval in seconds for active healthchecks", 
      "type": "integer"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "monitor_port": {
      "description": "Typically, monitors perform healthchecks to Group members using the member IP address and pool_port. However, in some cases, customers prefer to run healthchecks against a different port than the pool member port which handles actual application traffic. In such cases, the port to run healthchecks against can be specified in the monitor_port value.", 
      "maximum": 65535, 
      "minimum": 0, 
      "required": false, 
      "title": "Monitor port for active healthchecks", 
      "type": "int"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": [
        "TcpPolicyLbMonitorProfile", 
        "UdpPolicyLbMonitorProfile", 
        "IcmpPolicyLbMonitorProfile", 
        "HttpPolicyLbMonitorProfile", 
        "HttpsPolicyLbMonitorProfile"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "rise_count": {
      "default": 3, 
      "description": "Once a member is DOWN, a specified number of consecutive successful healthchecks specified by rise_count will bring the member back to UP state.", 
      "required": false, 
      "title": "Monitor rise count for active healthchecks", 
      "type": "integer"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "timeout": {
      "default": 15, 
      "description": "Timeout specified in seconds.  After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.", 
      "required": false, 
      "title": "Monitor timeout in seconds for active healthchecks", 
      "type": "integer"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "PolicyLbMonitorProfile for active health checks over ICMP", 
  "type": "object"
}

Icon (type)

{
  "additionalProperties": false, 
  "description": "Icon to be applied at dashboard for widgets and UI elements.", 
  "id": "Icon", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "properties": {
    "placement": {
      "default": "PRE", 
      "description": "If specified as PRE, the icon appears before the UI element. If set as POST, the icon appears after the UI element.", 
      "enum": [
        "PRE", 
        "POST"
      ], 
      "title": "Position at which to display icon, if any", 
      "type": "string"
    }, 
    "tooltip": {
      "description": "Multi-line text to be shown on tooltip while hovering over the icon.", 
      "items": {
        "$ref": "Tooltip
      }, 
      "title": "Multi-line tooltip", 
      "type": "array"
    }, 
    "type": {
      "description": "Icon will be rendered based on its type. For example, if ERROR is chosen, then icon representing error will be rendered.", 
      "enum": [
        "ERROR", 
        "WARNING", 
        "INFO", 
        "INPROGRESS", 
        "SUCCESS", 
        "DETAIL", 
        "NOT_AVAILABLE", 
        "SECURITY", 
        "NETWORKING", 
        "LOAD_BALANCER", 
        "VPN", 
        "DOMAIN", 
        "GROUP", 
        "DISTRIBUTED_FIREWALL", 
        "NETWORKING_TIER0", 
        "NETWORKING_TIER1", 
        "SEGMENT", 
        "SYSTEM", 
        "SYSTEM_FABRIC", 
        "SYSTEM_BACKUPRESTORE", 
        "INVENTORY_GROUPS", 
        "SECURITY_DFW"
      ], 
      "title": "Type of icon", 
      "type": "string"
    }
  }, 
  "title": "Icon", 
  "type": "object"
}

IdentityGroupExpression (type)

{
  "additionalProperties": false, 
  "description": "Represents a list of identity group (Ad group SID) expressions.", 
  "extends": {
    "$ref": "Expression
  }, 
  "id": "IdentityGroupExpression", 
  "module_id": "Policy", 
  "polymorphic-type-descriptor": {
    "type-identifier": "IdentityGroupExpression"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "identity_groups": {
      "description": "This array consists of set of identity group object. All members within this array are implicitly OR'ed together.", 
      "items": {
        "$ref": "IdentityGroupInfo
      }, 
      "maxItems": 500, 
      "minItems": 1, 
      "required": true, 
      "title": "Array of identity group", 
      "type": "array"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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", 
        "ExternalIDExpression", 
        "PathExpression", 
        "IdentityGroupExpression"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "IdentityGroup expression node", 
  "type": "object"
}

IdentityGroupInfo (type)

{
  "id": "IdentityGroupInfo", 
  "module_id": "PolicyIdentity", 
  "properties": {
    "distinguished_name": {
      "description": "Each LDAP object is uniquely identified by its distinguished name (DN). A DN is a sequence of relative distinguished names (RDN) connected by commas. e.g. CN=Larry Cole,CN=admin,DC=corp,DC=acme,DC=com. A valid fully qualified distinguished name should be provided to include specific groups else the create / update realization of the Group containing an invalid/ partial DN will fail. This value is valid only if it matches to exactly 1 LDAP object on the LDAP server.", 
      "required": true, 
      "title": "LDAP distinguished name", 
      "type": "string"
    }, 
    "domain_base_distinguished_name": {
      "description": "This is the base distinguished name for the domain where this particular group resides. (e.g. dc=example,dc=com) Each active directory domain has a domain naming context (NC), which contains domain-specific data. The root of this naming context is represented by a domain's distinguished name (DN) and is typically referred to as the NC head.", 
      "required": true, 
      "title": "Identity (Directory) domain base distinguished name", 
      "type": "string"
    }, 
    "sid": {
      "description": "A security identifier (SID) is a unique value of variable length used to identify a trustee. A SID consists of the following components: The revision level of the SID structure; A 48-bit identifier authority value that identifies the authority that issued the SID; A variable number of subauthority or relative identifier (RID) values that uniquely identify the trustee relative to the authority that issued the SID. This field is only populated for Microsoft Active Directory identity store.", 
      "required": false, 
      "title": "Identity (Directory) Group SID (security identifier)", 
      "type": "string"
    }
  }, 
  "title": "Identity (Directory) group", 
  "type": "object"
}

IdentitySourceLdapServer (type)

{
  "description": "Information about a single LDAP server.", 
  "id": "IdentitySourceLdapServer", 
  "module_id": "LdapIdentitySources", 
  "properties": {
    "bind_identity": {
      "description": "A username used to authenticate to the directory when admnistering roles in NSX. This user should have privileges to search the LDAP directory for groups and users. This user is also used in some cases (OpenLDAP) to look up an NSX user's distinguished name based on their NSX login name. If omitted, NSX will authenticate to the LDAP server using an LDAP anonymous bind operation. For Active Directory, provide a userPrincipalName (e.g. [email protected]) or the full distinguished nane. For OpenLDAP, provide the distinguished name of the user (e.g. uid=admin, cn=airius, dc=com).", 
      "title": "Username or DN for LDAP authentication", 
      "type": "string"
    }, 
    "certificates": {
      "description": "If using LDAPS or STARTTLS, provide the X.509 certificate of the LDAP server in PEM format. This property is not required when connecting without TLS encryption and is ignored in that case.", 
      "items": {
        "type": "string"
      }, 
      "title": "TLS certificate(s) for LDAP server(s)", 
      "type": "array"
    }, 
    "enabled": {
      "default": true, 
      "description": "Allows the LDAP server to be enabled or disabled. When disabled, this LDAP server will not be used to authenticate users.", 
      "title": "If true, this LDAP server is enabled", 
      "type": "boolean"
    }, 
    "password": {
      "description": "A password used when authenticating to the directory.", 
      "sensitive": true, 
      "title": "Username for LDAP authentication", 
      "type": "string"
    }, 
    "url": {
      "description": "The URL for the LDAP server. Supported URL schemes are LDAP and LDAPS. Either a hostname or an IP address may be given, and the port number is optional and defaults to 389 for the LDAP scheme and 636 for the LDAPS scheme.", 
      "required": true, 
      "title": "The URL for the LDAP server", 
      "type": "string"
    }, 
    "use_starttls": {
      "default": false, 
      "description": "If set to true, Use the StartTLS extended operation to upgrade the connection to TLS before sending any sensitive information. The LDAP server must support the StartTLS extended operation in order for this protocol to operate correctly. This option is ignored if the URL scheme is LDAPS.", 
      "title": "Enable/disable StartTLS", 
      "type": "boolean"
    }
  }, 
  "title": "An LDAP server", 
  "type": "object"
}

IdentitySourceLdapServerEndpoint (type)

{
  "description": "Information about a single LDAP server endpoint.", 
  "id": "IdentitySourceLdapServerEndpoint", 
  "module_id": "LdapIdentitySources", 
  "properties": {
    "url": {
      "description": "The URL for the LDAP server. Supported URL schemes are LDAP and LDAPS. Either a hostname or an IP address may be given, and the port number is optional and defaults to 389 for the LDAP scheme and 636 for the LDAPS scheme.", 
      "required": true, 
      "title": "The URL for the LDAP server", 
      "type": "string"
    }, 
    "use_starttls": {
      "default": false, 
      "description": "If set to true, Use the StartTLS extended operation to upgrade the connection to TLS before sending any sensitive information. The LDAP server must support the StartTLS extended operation in order for this protocol to operate correctly. This option is ignored if the URL scheme is LDAPS.", 
      "title": "Eanble/disable StartTLS", 
      "type": "boolean"
    }
  }, 
  "title": "An LDAP server endpoint", 
  "type": "object"
}

IdentitySourceLdapServerProbeResult (type)

{
  "description": "The results of probing an individual LDAP server.", 
  "id": "IdentitySourceLdapServerProbeResult", 
  "module_id": "LdapIdentitySources", 
  "properties": {
    "errors": {
      "description": "Detail about errors encountered during the probe.", 
      "items": {
        "$ref": "LdapProbeError
      }, 
      "title": "Error details", 
      "type": "array"
    }, 
    "result": {
      "description": "Overall result of the probe. If the probe was able to connect to the LDAP service, authenticate using the provided credentials, and perform searches of the configured user and group search bases without error, the result is SUCCESS. Otherwise, the result is FAILURE, and additional details may be found in the errors property.", 
      "enum": [
        "SUCCESS", 
        "FAILURE"
      ], 
      "title": "Overall result", 
      "type": "string"
    }, 
    "url": {
      "description": "THe URL of the probed LDAP host.", 
      "title": "LDAP Server URL", 
      "type": "string"
    }
  }, 
  "title": "Results from one LDAP server probe", 
  "type": "object"
}

IdsClusterConfig (type)

{
  "additionalProperties": false, 
  "description": "IDS configuration to enable/disable IDS on cluster level.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "IdsClusterConfig", 
  "module_id": "PolicyIDS", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "cluster": {
      "$ref": "PolicyResourceReference, 
      "description": "Contains policy resource reference object", 
      "readonly": false, 
      "required": true, 
      "title": "PolicyResourceReference"
    }, 
    "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ids_enabled": {
      "description": "If set to true, IDS is enabled on the respective cluster", 
      "readonly": false, 
      "required": true, 
      "title": "Ids enabled flag", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Intrusion Detection System cluster configuration", 
  "type": "object"
}

IdsProfile (type)

{
  "additionalProperties": false, 
  "description": "IDS Profile which contains the signatures and will be used in IDS rules.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "IdsProfile", 
  "module_id": "PolicyIDS", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "criteria": {
      "description": "Represents the filtering criteria for the IDS Profile. 1. A non-empty criteria list, must be of odd size. In a list, with indices starting from 0, all IdsProfileFilterCriteria must be at even indices, separated by the IdsProfileConjunctionOperator AND at odd indices. 2. There may be at most 7 IdsProfileCriteria objects inside a list.", 
      "items": {
        "$ref": "IdsProfileCriteria
      }, 
      "maxItems": 7, 
      "required": false, 
      "title": "Filtering criteria of IDS Profile", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "overridden_signatures": {
      "description": "Represents the signatures that has been  overridden for this Profile.", 
      "items": {
        "$ref": "IdsProfileLocalSignature
      }, 
      "required": false, 
      "title": "Represents the signatures that is overridden for the Profile", 
      "type": "array"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "profile_severity": {
      "description": "Represents the severities of signatures which are part of this profile.", 
      "items": {
        "$ref": "ProfileSeverity
      }, 
      "required": false, 
      "title": "IDS Profile severity", 
      "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"
    }, 
    "severities": {
      "deprecated": true, 
      "description": "Represents the severities of signatures which are part of this profile.", 
      "items": {
        "$ref": "IdsProfileSeverity
      }, 
      "required": false, 
      "title": "IDS Profile severity", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Intrusion Detection System Profile", 
  "type": "object"
}

IdsProfileConjunctionOperator (type)

{
  "additionalProperties": false, 
  "description": "Represents the operator AND.", 
  "extends": {
    "$ref": "IdsProfileCriteria
  }, 
  "id": "IdsProfileConjunctionOperator", 
  "module_id": "PolicyIDS", 
  "polymorphic-type-descriptor": {
    "type-identifier": "IdsProfileConjunctionOperator"
  }, 
  "properties": {
    "operator": {
      "enum": [
        "AND"
      ], 
      "required": true, 
      "title": "IDS Profile Filter Condition", 
      "type": "string"
    }, 
    "resource_type": {
      "enum": [
        "IdsProfileConjunctionOperator", 
        "IdsProfileFilterCriteria"
      ], 
      "required": true, 
      "type": "string"
    }
  }, 
  "title": "Represents the operator AND", 
  "type": "object"
}

IdsProfileCriteria (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "description": "All the filtering criteria objects extend from this abstract class. This is present for extensibility.", 
  "id": "IdsProfileCriteria", 
  "module_id": "PolicyIDS", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "resource_type"
  }, 
  "properties": {
    "resource_type": {
      "enum": [
        "IdsProfileConjunctionOperator", 
        "IdsProfileFilterCriteria"
      ], 
      "required": true, 
      "type": "string"
    }
  }, 
  "title": "Base class for IDS Profile criteria", 
  "type": "object"
}

IdsProfileFilterCriteria (type)

{
  "additionalProperties": false, 
  "description": "Represents the filtering criteria of a IDS Profile.", 
  "extends": {
    "$ref": "IdsProfileCriteria
  }, 
  "id": "IdsProfileFilterCriteria", 
  "module_id": "PolicyIDS", 
  "polymorphic-type-descriptor": {
    "type-identifier": "IdsProfileFilterCriteria"
  }, 
  "properties": {
    "filter_name": {
      "description": "Represents the filter for IDS Profile.", 
      "enum": [
        "CVSS", 
        "ATTACK_TARGET", 
        "ATTACK_TYPE", 
        "PRODUCT_AFFECTED"
      ], 
      "required": true, 
      "title": "Represents the filter name", 
      "type": "string"
    }, 
    "filter_value": {
      "description": "Represents the value of selected filter name. Note : The supported values for filter name CVSS are    NONE, LOW, MEDIUM, HIGH, CRITICAL.    NONE     means CVSS score as 0.0    LOW      means CVSS score as 0.1-3.9    MEDIUM   means CVSS score as 4.0-6.9    HIGH     means CVSS score as 7.0-8.9    CRITICAL means CVSS score as 9.0-10.0", 
      "items": {
        "type": "string"
      }, 
      "required": true, 
      "title": "Represents the value of selected filter name", 
      "type": "array"
    }, 
    "resource_type": {
      "enum": [
        "IdsProfileConjunctionOperator", 
        "IdsProfileFilterCriteria"
      ], 
      "required": true, 
      "type": "string"
    }
  }, 
  "title": "IDS Profile filter criteria", 
  "type": "object"
}

IdsProfileLocalSignature (type)

{
  "additionalProperties": false, 
  "description": "IDS Profile local signature.", 
  "extends": {
    "$ref": "GlobalIdsSignature
  }, 
  "id": "IdsProfileLocalSignature", 
  "module_id": "PolicyIDS", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "action": {
      "description": "It denotes the global action of a IDS Signature. This will take precedence over IDS signature's action.", 
      "enum": [
        "ALERT", 
        "DROP", 
        "REJECT"
      ], 
      "title": "Global IDS signature's action", 
      "type": "string"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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"
    }, 
    "enable": {
      "default": true, 
      "description": "Flag through which user can Enable/Disable a Signature at Global Level.", 
      "title": "Flag to Enable/Disable a IDS Signature globally.", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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"
    }, 
    "signature_id": {
      "description": "Represents the Signature's id.", 
      "required": true, 
      "title": "Signature ID", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "IDS Profile local signature", 
  "type": "object"
}

IdsProfileSeverity (type)

{
  "additionalProperties": false, 
  "description": "Intrusion Detection System Profile severity.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "IdsProfileSeverity", 
  "module_id": "PolicyIDS", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ignore_signatures": {
      "description": "Contains the id of signatures that will be ignored as part of the profile. This field is deprecated, please use ignore_signatures field under IdsProfile to ignore the signatures.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Represents the signatures that will be ignored", 
      "type": "array"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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"
    }, 
    "severity": {
      "description": "Represents the severity of a profile.", 
      "enum": [
        "CRITICAL", 
        "HIGH", 
        "MEDIUM", 
        "LOW"
      ], 
      "required": true, 
      "title": "Severity of profile", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Intrusion Detection System Profile severity", 
  "type": "object"
}

IdsRule (type)

{
  "additionalProperties": false, 
  "description": "Represents the Intrusion Detection System rule which indicates the action to be performed for the corresponding workload groups.", 
  "extends": {
    "$ref": "BaseRule
  }, 
  "id": "IdsRule", 
  "module_id": "PolicyIDS", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "action": {
      "description": "The action to be applied.", 
      "enum": [
        "DETECT", 
        "DETECT_PREVENT"
      ], 
      "title": "Action", 
      "type": "string"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "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 domains. Along with paths we support IP Address of type IPv4 and IPv6. IP Address can be in one of the format(CIDR, IP Address, Range of IP Address). 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.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 128, 
      "required": false, 
      "title": "Destination group paths", 
      "type": "array"
    }, 
    "destinations_excluded": {
      "default": false, 
      "description": "If set to true, the rule gets applied on all the groups that are NOT part of the destination groups. If false, the rule applies to the destination groups", 
      "readonly": false, 
      "required": false, 
      "title": "Negation of destination groups", 
      "type": "boolean"
    }, 
    "direction": {
      "default": "IN_OUT", 
      "description": "Define direction of traffic.", 
      "enum": [
        "IN", 
        "OUT", 
        "IN_OUT"
      ], 
      "required": false, 
      "title": "Direction", 
      "type": "string"
    }, 
    "disabled": {
      "default": false, 
      "description": "Flag to disable the rule. Default is enabled.", 
      "readonly": false, 
      "required": false, 
      "title": "Flag to disable the rule", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ids_profiles": {
      "description": "collections of IDS profiles.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 1, 
      "minItems": 1, 
      "required": false, 
      "title": "IDS profiles", 
      "type": "array"
    }, 
    "ip_protocol": {
      "description": "Type of IP packet that should be matched while enforcing the rule. The value is set to IPV4_IPV6 for Layer3 rule if not specified. For Layer2/Ether rule the value must be null.", 
      "enum": [
        "IPV4", 
        "IPV6", 
        "IPV4_IPV6"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "IPv4 vs IPv6 packet type", 
      "type": "string"
    }, 
    "is_default": {
      "description": "A flag to indicate whether rule is a default rule.", 
      "readonly": true, 
      "required": false, 
      "title": "Default rule flag", 
      "type": "boolean"
    }, 
    "logged": {
      "default": false, 
      "description": "Flag to enable packet logging. Default is disabled.", 
      "readonly": false, 
      "required": false, 
      "title": "Enable logging flag", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "notes": {
      "description": "Text for additional notes on changes.", 
      "maxLength": 2048, 
      "readonly": false, 
      "required": false, 
      "title": "Text for additional notes on changes", 
      "type": "string"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "profiles": {
      "description": "Holds the list of layer 7 service profile paths. These profiles accept attributes and sub-attributes of various network services (e.g. L4 AppId, encryption algorithm, domain name, etc) as key value pairs.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 128, 
      "required": false, 
      "title": "Layer 7 service profiles", 
      "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"
    }, 
    "rule_id": {
      "description": "This is a unique 4 byte positive number that is assigned by the system.  This rule id is passed all the way down to the data path. The first 1GB (1000 to 2^30) will be shared by GM and LM with zebra style striped number space. For E.g 1000 to (1Million -1) by LM, (1M - 2M-1) by GM and so on.", 
      "readonly": true, 
      "required": false, 
      "title": "Unique rule ID", 
      "type": "integer"
    }, 
    "scope": {
      "description": "The list of policy paths where the rule is applied LR/Edge/T0/T1/LRP etc. Note that a given rule can be applied on multiple LRs/LRPs.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 128, 
      "required": false, 
      "type": "array"
    }, 
    "sequence_number": {
      "description": "This field is used to resolve conflicts between multiple Rules under Security or Gateway Policy for a Domain If no sequence number is specified in the payload, a value of 0 is assigned by default. If there are multiple rules with the same sequence number then their order is not deterministic. If a specific order of rules is desired, then one has to specify unique sequence numbers or use the POST request on the rule entity with a query parameter action=revise to let the framework assign a sequence number", 
      "minimum": 0, 
      "required": false, 
      "title": "Sequence number of the this Rule", 
      "type": "int"
    }, 
    "service_entries": {
      "description": "In order to specify raw services this can be used, along with services which contains path to services. This can be empty or null.", 
      "items": {
        "$ref": "ServiceEntry
      }, 
      "maxItems": 128, 
      "required": false, 
      "title": "Raw services", 
      "type": "array"
    }, 
    "services": {
      "description": "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.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 128, 
      "required": false, 
      "title": "Names of services", 
      "type": "array"
    }, 
    "source_groups": {
      "description": "We need paths as duplicate names may exist for groups under different domains. Along with paths we support IP Address of type IPv4 and IPv6. IP Address can be in one of the format(CIDR, IP Address, Range of IP Address). 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.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 128, 
      "required": false, 
      "title": "Source group paths", 
      "type": "array"
    }, 
    "sources_excluded": {
      "default": false, 
      "description": "If set to true, the rule gets applied on all the groups that are NOT part of the source groups. If false, the rule applies to the source groups", 
      "readonly": false, 
      "required": false, 
      "title": "Negation of source groups", 
      "type": "boolean"
    }, 
    "tag": {
      "description": "User level field which will be printed in CLI and packet logs.", 
      "required": false, 
      "title": "Tag applied on the rule", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "A rule specifies the IDS security policy rule between the workload groups", 
  "type": "object"
}

IdsSecurityPolicy (type)

{
  "description": "Represents the Intrusion Detection System Security Policy, which contains  the list of IDS Rules.", 
  "extends": {
    "$ref": "Policy
  }, 
  "id": "IdsSecurityPolicy", 
  "module_id": "PolicyIDS", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "category": {
      "description": "- Distributed Firewall - Policy framework provides five pre-defined categories for classifying a security policy. They are \"Ethernet\",\"Emergency\", \"Infrastructure\" \"Environment\" and \"Application\". There is a pre-determined order in which the policy framework manages the priority of these security policies. Ethernet category is for supporting layer 2 firewall rules. The other four categories are applicable for layer 3 rules. Amongst them, the Emergency category has the highest priority followed by Infrastructure, Environment and then Application rules. Administrator can choose to categorize a security policy into the above categories or can choose to leave it empty. If empty it will have the least precedence w.r.t the above four categories. - Edge Firewall - Policy Framework for Edge Firewall provides six pre-defined categories \"Emergency\", \"SystemRules\", \"SharedPreRules\", \"LocalGatewayRules\", \"AutoServiceRules\" and \"Default\", in order of priority of rules. All categories are allowed for Gatetway Policies that belong to 'default' Domain. However, for user created domains, category is restricted to \"SharedPreRules\" or \"LocalGatewayRules\" only. Also, the users can add/modify/delete rules from only the \"SharedPreRules\" and \"LocalGatewayRules\" categories. If user doesn't specify the category then defaulted to \"Rules\". System generated category is used by NSX created rules, for example BFD rules. Autoplumbed category used by NSX verticals to autoplumb data path rules. Finally, \"Default\" category is the placeholder default rules with lowest in the order of priority.", 
      "required": false, 
      "title": "A way to classify a security policy, if needed.", 
      "type": "string"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "comments": {
      "description": "Comments for security policy lock/unlock.", 
      "readonly": false, 
      "required": false, 
      "title": "SecurityPolicy lock/unlock comments", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "internal_sequence_number": {
      "description": "This field is to indicate the internal sequence number of a policy with respect to the policies across categories.", 
      "readonly": true, 
      "title": "Internal sequence number", 
      "type": "int"
    }, 
    "is_default": {
      "description": "A flag to indicate whether policy is a default policy.", 
      "readonly": true, 
      "required": false, 
      "title": "Default policy flag", 
      "type": "boolean"
    }, 
    "lock_modified_by": {
      "description": "ID of the user who last modified the lock for the secruity policy.", 
      "readonly": true, 
      "required": false, 
      "title": "User who locked the security policy", 
      "type": "string"
    }, 
    "lock_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "description": "SecurityPolicy locked/unlocked time in epoch milliseconds.", 
      "readonly": true, 
      "required": false, 
      "title": "SecuirtyPolicy locked/unlocked time"
    }, 
    "locked": {
      "default": false, 
      "description": "Indicates whether a security policy should be locked. If the security policy is locked by a user, then no other user would be able to modify this security policy. Once the user releases the lock, other users can update this security policy.", 
      "required": false, 
      "title": "Lock a security policy", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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"
    }, 
    "rule_count": {
      "description": "The count of rules in the policy.", 
      "readonly": true, 
      "title": "Rule count", 
      "type": "int"
    }, 
    "rules": {
      "items": {
        "$ref": "IdsRule
      }, 
      "required": false, 
      "title": "IDS Rules that are a part of this SecurityPolicy", 
      "type": "array"
    }, 
    "scheduler_path": {
      "description": "Provides a mechanism to apply the rules in this policy for a specified time duration.", 
      "readonly": false, 
      "required": false, 
      "title": "Path to the scheduler for time based scheduling", 
      "type": "string"
    }, 
    "scope": {
      "description": "The list of group paths where the rules in this policy will get applied. This scope will take precedence over rule level scope. Supported only for security and redirection policies. In case of RedirectionPolicy, it is expected only when the policy is NS and redirecting to service chain.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 128, 
      "required": false, 
      "type": "array"
    }, 
    "sequence_number": {
      "description": "This field is used to resolve conflicts between security policies across domains. In order to change the sequence number of a policy one can fire a POST request on the policy entity with a query parameter action=revise The sequence number field will reflect the value of the computed sequence number upon execution of the above mentioned POST request. For scenarios where the administrator is using a template to update several security policies, the only way to set the sequence number is to explicitly specify the sequence number for each security policy. If no sequence number is specified in the payload, a value of 0 is assigned by default. If there are multiple policies with the same sequence number then their order is not deterministic. If a specific order of policies is desired, then one has to specify unique sequence numbers or use the POST request on the policy entity with a query parameter action=revise to let the framework assign a sequence number", 
      "minimum": 0, 
      "title": "Sequence number to resolve conflicts across Domains", 
      "type": "int"
    }, 
    "stateful": {
      "description": "Stateful or Stateless nature of security policy is enforced on all rules in this security policy. When it is stateful, the state of the network connects are tracked and a stateful packet inspection is performed. Layer3 security policies can be stateful or stateless. By default, they are stateful. Layer2 security policies can only be stateless.", 
      "readonly": false, 
      "required": false, 
      "title": "Stateful nature of the entries within this security policy.", 
      "type": "boolean"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "tcp_strict": {
      "description": "Ensures that a 3 way TCP handshake is done before the data packets are sent. tcp_strict=true is supported only for stateful security policies. If the tcp_strict flag is not specified and the security policy is stateful, then tcp_strict will be set to true.", 
      "readonly": false, 
      "required": false, 
      "title": "Enforce strict tcp handshake before allowing data packets", 
      "type": "boolean"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Contains ordered list of IDS Rules", 
  "type": "object"
}

IdsSettings (type)

{
  "additionalProperties": false, 
  "description": "Represents the Intrusion Detection System settings.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "IdsSettings", 
  "module_id": "PolicyIDS", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "auto_update": {
      "default": false, 
      "description": "Parameter to let the user decide whether to update the IDS Signatures automatically or not.", 
      "required": false, 
      "title": "Auto update signatures flag", 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ids_ever_enabled": {
      "description": "Flag which tells whether IDS was ever enabled.", 
      "readonly": true, 
      "required": false, 
      "title": "Flag which tells whether IDS was ever enabled.", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Intrusion Detection System settings\n", 
  "type": "object"
}

IdsSignature (type)

{
  "additionalProperties": false, 
  "description": "Intrusion Detection System Signature .", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "IdsSignature", 
  "module_id": "PolicyIDS", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "action": {
      "description": "Signature action.", 
      "required": false, 
      "title": "Represents the signature's action", 
      "type": "string"
    }, 
    "attack_target": {
      "description": "Target of the signature.", 
      "required": false, 
      "title": "Signature attack target", 
      "type": "string"
    }, 
    "categories": {
      "description": "Represents the internal categories a signature belongs to.", 
      "items": {
        "$ref": "IdsSignatureInternalCategory
      }, 
      "required": false, 
      "title": "IDS Signature Internal category", 
      "type": "array"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "class_type": {
      "description": "Class type of Signature.", 
      "required": false, 
      "title": "Signature class type", 
      "type": "string"
    }, 
    "cves": {
      "description": "CVE score", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Represents the cve score.", 
      "type": "array"
    }, 
    "cvss": {
      "description": "Represents the cvss value of a Signature. The value is derived from cvssv3 or cvssv2 score. NONE     means cvssv3/cvssv2 score as 0.0 LOW      means cvssv3/cvssv2 score as 0.1-3.9 MEDIUM   means cvssv3/cvssv2 score as 4.0-6.9 HIGH     means cvssv3/cvssv2 score as 7.0-8.9 CRITICAL means cvssv3/cvssv2 score as 9.0-10.0", 
      "enum": [
        "NONE", 
        "LOW", 
        "MEDIUM", 
        "HIGH", 
        "CRITICAL"
      ], 
      "required": false, 
      "title": "CVSS of signature", 
      "type": "string"
    }, 
    "cvssv2": {
      "description": "Signature cvssv2 score.", 
      "required": false, 
      "title": "Signature cvssv2 score", 
      "type": "string"
    }, 
    "cvssv3": {
      "description": "Signature cvssv3 score.", 
      "required": false, 
      "title": "Signature cvssv3 score", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "direction": {
      "description": "Source-destination direction.", 
      "title": "Direction", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "enable": {
      "description": "Flag which tells whether the signature is enabled or not.", 
      "required": false, 
      "title": "Enable/Disable flag", 
      "type": "boolean"
    }, 
    "flow": {
      "description": "Flow established from server, from client etc.", 
      "required": false, 
      "title": "Flow established.", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "malware_family": {
      "description": "Family of the malware tracked in the signature.", 
      "title": "Malware Family", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "name": {
      "description": "Signature name.", 
      "required": false, 
      "title": "Represents the signature name", 
      "type": "string"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "performance_impact": {
      "description": "Performance impact of the signature.", 
      "title": "Performance impact", 
      "type": "string"
    }, 
    "policy": {
      "description": "Signature policy.", 
      "items": {
        "type": "string"
      }, 
      "title": "Policy", 
      "type": "array"
    }, 
    "product_affected": {
      "description": "Product affected by this signature.", 
      "required": false, 
      "title": "Signature product affected", 
      "type": "string"
    }, 
    "protocol": {
      "description": "Protocol used in the packet analysis.", 
      "title": "Protocol", 
      "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"
    }, 
    "severity": {
      "description": "Represents the severity of the Signature.", 
      "required": false, 
      "title": "Signature severity", 
      "type": "string"
    }, 
    "signature_id": {
      "description": "Represents the Signature's id.", 
      "required": false, 
      "title": "Signature ID", 
      "type": "string"
    }, 
    "signature_revision": {
      "description": "Represents revision of the Signature.", 
      "required": false, 
      "title": "Signature revision", 
      "type": "string"
    }, 
    "signature_severity": {
      "description": "Signature vendor set severity of the signature rule.", 
      "title": "Signature severity", 
      "type": "string"
    }, 
    "tag": {
      "description": "Vendor assigned classification tag.", 
      "items": {
        "type": "string"
      }, 
      "title": "Signature tag", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "type": {
      "description": "Signature type.", 
      "items": {
        "type": "string"
      }, 
      "title": "Type", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }, 
    "urls": {
      "description": "List of mitre attack URLs pertaining to signature", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "List of mitre attack URLs pertaining to signature.", 
      "type": "array"
    }
  }, 
  "title": "Intrusion Detection System Signature", 
  "type": "object"
}

IdsSignatureInternalCategory (type)

{
  "additionalProperties": false, 
  "description": "Represents the internal categories. APPLICATION : IDS signature having protocol comes under APPLICATION internal category. MALWARE: IDS signature having malware_family comes under this internal category. VULNERABILITY : IDS signature having cvssv3 score comes under this internal category.", 
  "enum": [
    "APPLICATION", 
    "MALWARE", 
    "VULNERABILITY"
  ], 
  "id": "IdsSignatureInternalCategory", 
  "module_id": "PolicyIDS", 
  "title": "IDS signature internal categories", 
  "type": "string"
}

IdsSignatureStatus (type)

{
  "additionalProperties": false, 
  "description": "Ids signature status.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "IdsSignatureStatus", 
  "module_id": "PolicyIDS", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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"
    }, 
    "download_status": {
      "description": "READY means signatures were downloaded and parsed successfully. PENDING means that signatures download is in progress. ERROR means error occurred during signature processing. DISABLED means IDS is disabled.", 
      "enum": [
        "READY", 
        "PENDING", 
        "ERROR", 
        "DISABLED"
      ], 
      "readonly": true, 
      "title": "IDS signature download status", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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"
    }, 
    "signature_status": {
      "description": "AVAILABLE means the signatures are available for the version. UNAVAILABLE means there are no available signatures for the version.", 
      "enum": [
        "AVAILABLE", 
        "UNAVAILABLE"
      ], 
      "readonly": true, 
      "title": "IDS signature status", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }, 
    "version_id": {
      "description": "Represents the version id.", 
      "readonly": true, 
      "title": "Version Id", 
      "type": "string"
    }
  }, 
  "title": "Intrusion Detection System signature status", 
  "type": "object"
}

IdsStandaloneHostConfig (type)

{
  "additionalProperties": false, 
  "description": "IDS configuration to enable/disable IDS on standalone host level.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "IdsStandaloneHostConfig", 
  "module_id": "PolicyIDS", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ids_enabled": {
      "description": "If set to true, IDS is enabled on standalone hosts.", 
      "readonly": false, 
      "required": true, 
      "title": "IDS enabled flag", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Intrusion Detection System configuration", 
  "type": "object"
}

IkeDigestAlgorithm (type)

{
  "additionalProperties": false, 
  "description": "The IkeDigestAlgorithms are used to verify message integrity during Ike negotiation. SHA1 produces 160 bits hash and SHA2_XXX produces XXX bit hash.", 
  "enum": [
    "SHA1", 
    "SHA2_256", 
    "SHA2_384", 
    "SHA2_512"
  ], 
  "id": "IkeDigestAlgorithm", 
  "module_id": "PolicyIPSecVpn", 
  "title": "Digest Algorithms used in IKE negotiations", 
  "type": "string"
}

IkeEncryptionAlgorithm (type)

{
  "additionalProperties": false, 
  "description": "IKEEncryption algorithms are used to ensure confidentiality of the messages exchanged during IKE negotiations. AES stands for Advanced Encryption Standards. AES_128 uses 128-bit keys whereas AES_256 uses 256-bit keys for encryption and decryption. AES_GCM stands for Advanced Encryption Standard(AES) in Galois/Counter Mode(GCM) and is used to provide both confidentiality and data origin authentication. AES_GCM composed of two separate functions one for encryption(AES) and one for authentication(GMAC). AES_GCM algorithms will be available with IKE_V2 version only. AES_GCM_128 uses 128-bit keys. AES_GCM_192 uses 192-bit keys. AES_GCM_256 uses 256-bit keys.", 
  "enum": [
    "AES_128", 
    "AES_256", 
    "AES_GCM_128", 
    "AES_GCM_192", 
    "AES_GCM_256"
  ], 
  "id": "IkeEncryptionAlgorithm", 
  "module_id": "PolicyIPSecVpn", 
  "title": "Encryption algorithms used in IKE", 
  "type": "string"
}

IncludedFieldsParameters (type)

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

Infra (type)

{
  "additionalProperties": false, 
  "description": "Infra space related policy.", 
  "extends": {
    "$ref": "AbstractSpace
  }, 
  "id": "Infra", 
  "module_id": "Policy", 
  "policy_hierarchical_children": [
    "ChildBfdProfile", 
    "ChildConstraint", 
    "ChildDhcpRelayConfig", 
    "ChildDhcpServerConfig", 
    "ChildDnsSecurityProfile", 
    "ChildDomain", 
    "ChildEvpnTenantConfig", 
    "ChildFloodProtectionProfile", 
    "ChildFullSyncState", 
    "ChildGatewayQosProfile", 
    "ChildGlobalManager", 
    "ChildGlobalManagerConfig", 
    "ChildIPDiscoveryProfile", 
    "ChildIPFIXDFWCollectorProfile", 
    "ChildIPFIXDFWProfile", 
    "ChildIPFIXL2CollectorProfile", 
    "ChildIPFIXL2Profile", 
    "ChildIpv6DadProfile", 
    "ChildIpv6NdraProfile", 
    "ChildMacDiscoveryProfile", 
    "ChildPolicyContextProfile", 
    "ChildPolicyDnsForwarderZone", 
    "ChildPolicyFirewallScheduler", 
    "ChildPolicyFirewallSessionTimerProfile", 
    "ChildPolicyLabel", 
    "ChildPortMirroringProfile", 
    "ChildQoSProfile", 
    "ChildSegment", 
    "ChildSegmentSecurityProfile", 
    "ChildService", 
    "ChildSite", 
    "ChildSpan", 
    "ChildSpoofGuardProfile", 
    "ChildTier0", 
    "ChildTier1", 
    "ChildTlsCertificate", 
    "ChildTlsCrl"
  ], 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "connectivity_strategy": {
      "deprecated": true, 
      "description": "The connectivity strategy is deprecated. Use default layer3 rule, /infra/domains/default/security-policies/default-layer3-security-policy/rules/default-layer3-rule. 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 WHITELIST_ENABLE_LOGGING - Whitelising with logging enabled BLACKLIST_ENABLE_LOGGING - Blacklisting with logging enabled NONE - No default rules are added.", 
      "enum": [
        "WHITELIST", 
        "BLACKLIST", 
        "WHITELIST_ENABLE_LOGGING", 
        "BLACKLIST_ENABLE_LOGGING", 
        "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.", 
      "items": {
        "$ref": "Domain
      }, 
      "required": false, 
      "title": "Domains for infra", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Infra", 
  "type": "object"
}

IngressBroadcastRateLimiter (type)

{
  "extends": {
    "$ref": "QoSBaseRateLimiter
  }, 
  "id": "IngressBroadcastRateLimiter", 
  "module_id": "PolicyQoS", 
  "polymorphic-type-descriptor": {
    "type-identifier": "IngressBroadcastRateLimiter"
  }, 
  "properties": {
    "average_bandwidth": {
      "default": 0, 
      "descrption": "Set custom average_bandwidth for the outbound network traffic\nfrom the VM to the logical network based on broadcast.\n", 
      "minimum": 0, 
      "title": "Average bandwidth in kb/s", 
      "type": "int"
    }, 
    "burst_size": {
      "default": 0, 
      "descrition": "Set custom burst_size for the outbound network traffic\nfrom the VM to the logical network based on broadcast.\n", 
      "minimum": 0, 
      "title": "Burst size in bytes", 
      "type": "int"
    }, 
    "enabled": {
      "required": true, 
      "type": "boolean"
    }, 
    "peak_bandwidth": {
      "default": 0, 
      "desription": "Set custom peak_bandwidth for the outbound network traffic\nfrom the VM to the logical network based on broadcast.\n", 
      "minimum": 0, 
      "title": "Peak bandwidth in kb/s", 
      "type": "int"
    }, 
    "resource_type": {
      "default": "IngressRateLimiter", 
      "description": "Type rate limiter", 
      "enum": [
        "IngressRateLimiter", 
        "IngressBroadcastRateLimiter", 
        "EgressRateLimiter"
      ], 
      "required": true, 
      "type": "string"
    }
  }, 
  "title": "A shaper that specifies ingress rate properties in kb/s", 
  "type": "object"
}

IngressRateLimiter (type)

{
  "extends": {
    "$ref": "QoSBaseRateLimiter
  }, 
  "id": "IngressRateLimiter", 
  "module_id": "PolicyQoS", 
  "polymorphic-type-descriptor": {
    "type-identifier": "IngressRateLimiter"
  }, 
  "properties": {
    "average_bandwidth": {
      "default": 0, 
      "description": "You can use the average bandwidth to reduce network congestion.", 
      "minimum": 0, 
      "title": "Average bandwidth in Mb/s", 
      "type": "int"
    }, 
    "burst_size": {
      "default": 0, 
      "description": "The burst duration is set in the burst size setting.", 
      "minimum": 0, 
      "title": "Burst size in bytes", 
      "type": "int"
    }, 
    "enabled": {
      "required": true, 
      "type": "boolean"
    }, 
    "peak_bandwidth": {
      "default": 0, 
      "description": "The peak bandwidth rate is used to support burst traffic.", 
      "minimum": 0, 
      "title": "Peak bandwidth in Mb/s", 
      "type": "int"
    }, 
    "resource_type": {
      "default": "IngressRateLimiter", 
      "description": "Type rate limiter", 
      "enum": [
        "IngressRateLimiter", 
        "IngressBroadcastRateLimiter", 
        "EgressRateLimiter"
      ], 
      "required": true, 
      "type": "string"
    }
  }, 
  "title": "A shaper that specifies ingress rate properties in Mb/s", 
  "type": "object"
}

InitiateClusterRestoreRequest (type)

{
  "id": "InitiateClusterRestoreRequest", 
  "module_id": "ClusterRestore", 
  "properties": {
    "ip_address": {
      "format": "hostname-or-ip", 
      "readonly": true, 
      "required": false, 
      "title": "IP address or FQDN of the node from which the backup was taken", 
      "type": "string"
    }, 
    "node_id": {
      "readonly": true, 
      "required": true, 
      "title": "Unique id of the backed-up configuration from which\nthe appliance will be restored\n", 
      "type": "string"
    }, 
    "timestamp": {
      "$ref": "EpochMsTimestamp, 
      "readonly": true, 
      "required": true, 
      "title": "Timestamp of the backed-up configuration from which\nthe appliance will be restored\n"
    }
  }, 
  "type": "object"
}

Injection (type)

{
  "additionalProperties": false, 
  "description": "Injection holding a key and a corresponding value.", 
  "id": "Injection", 
  "module_id": "PolicyReaction", 
  "properties": {
    "key": {
      "description": "Injection key.", 
      "required": true, 
      "title": "Key", 
      "type": "string"
    }, 
    "value": {
      "$ref": "InjectionValue, 
      "description": "Injection value.", 
      "required": true, 
      "title": "Value"
    }
  }, 
  "title": "Injection", 
  "type": "object"
}

InjectionValue (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "description": "Injection Value.", 
  "id": "InjectionValue", 
  "module_id": "PolicyReaction", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "resource_type"
  }, 
  "properties": {
    "resource_type": {
      "description": "Injection Value resource type.", 
      "enum": [
        "UnaryOperationBasedInjectionValue"
      ], 
      "required": true, 
      "title": "Resource Type", 
      "type": "string"
    }
  }, 
  "title": "Injection Value", 
  "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", 
  "module_id": "ClusterRestore", 
  "properties": {
    "actions": {
      "description": "A list of actions that are to be applied to resources", 
      "help_detail": "This attribute lists actions that are to be applied to the resources\nreferenced in the \"resources\" attribute. There is an m x n relationship\nbetween these actions and resources.\n", 
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "required": true, 
      "title": "Actions list", 
      "type": "array"
    }, 
    "fields": {
      "description": "A list of fields that are displayable to users in a table", 
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "required": true, 
      "title": "Displayable fields", 
      "type": "array"
    }, 
    "id": {
      "readonly": true, 
      "required": true, 
      "title": "UUID of the instruction", 
      "type": "string"
    }, 
    "name": {
      "readonly": true, 
      "required": true, 
      "title": "Instruction name", 
      "type": "string"
    }
  }, 
  "title": "Details of the instructions displayed during restore process", 
  "type": "object"
}

IntentEnforcementPointListRequestParams (type)

{
  "additionalProperties": false, 
  "description": "List request parameters containing intent path and enforcement point path", 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "IntentEnforcementPointListRequestParams", 
  "module_id": "PolicyGroupRealization", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "enforcement_point_path": {
      "description": "The path of the enforcement point from which the list of groups needs to be fetched. Forward slashes must be escaped using %2F. If no enforcement point path is specified, the default enforcement point is considered", 
      "required": false, 
      "title": "String Path of the enforcement point", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "intent_path": {
      "required": true, 
      "title": "String path of the intent object", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "List request parameters containing intent path and enforcement point path", 
  "type": "object"
}

IntentPathRequestParameter (type)

{
  "description": "Intent path for which state/realized entities would be fetched.", 
  "id": "IntentPathRequestParameter", 
  "module_id": "PolicyRealizedState", 
  "properties": {
    "intent_path": {
      "description": "Intent path of object, forward slashes must be escaped using %2F", 
      "required": true, 
      "title": "String Path of the intent object", 
      "type": "string"
    }, 
    "site_path": {
      "description": "Policy Path referencing a site. This is applicable only on a GlobalManager. If no site_path is specified, then based on the span of the intent the response will be fetched from the respective sites", 
      "required": false, 
      "title": "Policy Path of the site", 
      "type": "string"
    }
  }, 
  "title": "Parameter to filter realized entities by intent path", 
  "type": "object"
}

IntentRuntimeRequestParameters (type)

{
  "description": "Request parameters that represents a an intent path.", 
  "id": "IntentRuntimeRequestParameters", 
  "module_id": "PolicyBaseStatistics", 
  "properties": {
    "intent_path": {
      "description": "Policy Path referencing an intent object.", 
      "required": true, 
      "title": "Policy Path of the intent object", 
      "type": "string"
    }, 
    "site_path": {
      "description": "Policy Path referencing a site. This is applicable only on a GlobalManager. If no site_path is specified, then based on the span of the intent the response will be fetched from the respective sites", 
      "required": false, 
      "title": "Policy Path of the site from where the realization status needs to be fetched", 
      "type": "string"
    }
  }, 
  "title": "Request Parameters for Intent Runtime Information", 
  "type": "object"
}

IntentStatusRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "Request parameters that represents a binding between an intent path and whether the enforcement point specific status shall be retrieved from the enforcement point or not. A request can be parameterized with this pair and will be evaluated as follows: - <intent_path>: the request is evaluated on all enforcement points for the given intent with no enforced statuses' details returned. - <intent_path, include_enforced_status=true>: the request is evaluated on all enforcement points for the given intent with enforced statuses' details returned.", 
  "extends": {
    "$ref": "IntentRuntimeRequestParameters
  }, 
  "id": "IntentStatusRequestParameters", 
  "module_id": "PolicyRealizationStatus", 
  "properties": {
    "include_enforced_status": {
      "default": false, 
      "description": "Flag conveying whether to include detailed view of the enforcement point specific status or not.", 
      "title": "Include Enforced Status Flag", 
      "type": "boolean"
    }, 
    "intent_path": {
      "description": "Policy Path referencing an intent object.", 
      "required": true, 
      "title": "Policy Path of the intent object", 
      "type": "string"
    }, 
    "site_path": {
      "description": "Policy Path referencing a site. This is applicable only on a GlobalManager. If no site_path is specified, then based on the span of the intent the response will be fetched from the respective sites", 
      "required": false, 
      "title": "Policy Path of the site from where the realization status needs to be fetched", 
      "type": "string"
    }
  }, 
  "title": "Request Parameters for Intent Status Information", 
  "type": "object"
}

InterSitePortCounters (type)

{
  "extends": {
    "$ref": "LogicalRouterPortCounters
  }, 
  "id": "InterSitePortCounters", 
  "module_id": "AggSvcInterSite", 
  "properties": {
    "blocked_packets": {
      "description": "The total number of packets blocked.", 
      "required": false, 
      "title": "The number of blocked packets", 
      "type": "integer"
    }, 
    "dad_dropped_packets": {
      "description": "Number of duplicate address detected packets dropped.", 
      "required": false, 
      "title": "The number of duplicate address detected packets dropped", 
      "type": "integer"
    }, 
    "destination_unsupported_dropped_packets": {
      "description": "Number of packtes dropped as destination is not supported.", 
      "required": false, 
      "title": "The number of destination unsupported packets dropped", 
      "type": "integer"
    }, 
    "dropped_packets": {
      "description": "The total number of packets dropped.", 
      "required": false, 
      "title": "The number of dropped packets", 
      "type": "integer"
    }, 
    "firewall_dropped_packets": {
      "description": "Number of firewall packets dropped.", 
      "required": false, 
      "title": "The number of firewall packets dropped", 
      "type": "integer"
    }, 
    "frag_needed_dropped_packets": {
      "description": "Number of fragmentation needed packets dropped.", 
      "required": false, 
      "title": "The number of fragmentation needed packets dropped", 
      "type": "integer"
    }, 
    "ipsec_dropped_packets": {
      "description": "Number of IPSec packets dropped", 
      "required": false, 
      "title": "The number of IPSec packets dropped", 
      "type": "integer"
    }, 
    "ipsec_no_sa_dropped_packets": {
      "description": "Number of IPSec no security association packets dropped.", 
      "required": false, 
      "title": "The number of IPSec no security association packets dropped", 
      "type": "integer"
    }, 
    "ipsec_no_vti_dropped_packets": {
      "description": "Number of IPSec packets dropped as no VTI is present.", 
      "required": false, 
      "title": "The number of IPSec no VTI packets dropped", 
      "type": "integer"
    }, 
    "ipsec_pol_block_dropped_packets": {
      "description": "Number of IPSec policy block packets dropped.", 
      "required": false, 
      "title": "The number of IPSec policy block packets dropped", 
      "type": "integer"
    }, 
    "ipsec_pol_err_dropped_packets": {
      "description": "Number of IPSec policy error packets dropped.", 
      "required": false, 
      "title": "The number of IPSec policy error packets dropped", 
      "type": "integer"
    }, 
    "ipv6_dropped_packets": {
      "description": "Number of IPV6 packets dropped.", 
      "required": false, 
      "title": "The number of IPV6 packets dropped", 
      "type": "integer"
    }, 
    "kni_dropped_packets": {
      "description": "Number of DPDK kernal NIC interface packets dropped.", 
      "required": false, 
      "title": "The number of kernal NIC interface packets dropped", 
      "type": "integer"
    }, 
    "l4port_unsupported_dropped_packets": {
      "description": "Number of packets dropped due to unsupported L4 port.", 
      "required": false, 
      "title": "The number of L4 port unsupported packets dropped", 
      "type": "integer"
    }, 
    "malformed_dropped_packets": {
      "description": "Number of packtes dropped as they are malformed.", 
      "required": false, 
      "title": "The number of malformed packets dropped", 
      "type": "integer"
    }, 
    "no_arp_dropped_packets": {
      "description": "Number of no ARP packets dropped.", 
      "required": false, 
      "title": "The number of no ARP packets dropped", 
      "type": "integer"
    }, 
    "no_linked_dropped_packets": {
      "description": "Number of packets dropped as no linked ports are present.", 
      "required": false, 
      "title": "The number of no linked packets dropped", 
      "type": "integer"
    }, 
    "no_mem_dropped_packets": {
      "description": "Number of packets dropped due to insufficient memory.", 
      "required": false, 
      "title": "The number of no memory packets dropped", 
      "type": "integer"
    }, 
    "no_receiver_dropped_packets": {
      "description": "Number of packets dropped due to absence of receiver.", 
      "required": false, 
      "title": "The number of no receiver packets dropped", 
      "type": "integer"
    }, 
    "no_route_dropped_packets": {
      "desrciption": "Number of packets dropped due to absence of routes.", 
      "required": false, 
      "title": "The number of no route packets dropped", 
      "type": "integer"
    }, 
    "non_ip_dropped_packets": {
      "description": "Number of non IP packets dropped.", 
      "required": false, 
      "title": "The number of non IP packets dropped", 
      "type": "integer"
    }, 
    "proto_unsupported_dropped_packets": {
      "description": "Number of packets dropped as protocol is unsupported.", 
      "required": false, 
      "title": "The number of protocol unsupported packets dropped", 
      "type": "integer"
    }, 
    "redirect_dropped_packets": {
      "description": "Number of redirect packets dropped.", 
      "required": false, 
      "title": "The number of redirect packets dropped", 
      "type": "integer"
    }, 
    "rpf_check_dropped_packets": {
      "description": "Number of reverse-path forwarding check packets dropped.", 
      "required": false, 
      "title": "The number of reverse-path forwarding check packets dropped", 
      "type": "integer"
    }, 
    "service_insert_dropped_packets": {
      "description": "Number of service insert packets dropped.", 
      "required": false, 
      "title": "The number of service insert packets dropped", 
      "type": "integer"
    }, 
    "total_bytes": {
      "description": "The total number of bytes transferred.", 
      "required": false, 
      "title": "The total number of bytes", 
      "type": "integer"
    }, 
    "total_packets": {
      "description": "The total number of packets transferred.", 
      "required": false, 
      "title": "The total number of packets", 
      "type": "integer"
    }, 
    "ttl_exceeded_dropped_packets": {
      "description": "Number of time to live exceeded packets dropped.", 
      "required": false, 
      "title": "The number of time to live exceeded packets dropped", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

InterfaceArpCsvRecord (type)

{
  "extends": {
    "$ref": "CsvRecord
  }, 
  "id": "InterfaceArpCsvRecord", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "ip": {
      "$ref": "IPAddress, 
      "required": true, 
      "title": "The IP address"
    }, 
    "mac_address": {
      "required": true, 
      "title": "The MAC address", 
      "type": "string"
    }
  }, 
  "type": "object"
}

InterfaceArpEntry (type)

{
  "id": "InterfaceArpEntry", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "ip": {
      "$ref": "IPAddress, 
      "required": true, 
      "title": "The IP address"
    }, 
    "mac_address": {
      "required": true, 
      "title": "The MAC address", 
      "type": "string"
    }
  }, 
  "type": "object"
}

InterfaceArpProxy (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "InterfaceArpProxy", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "arp_proxy_entries": {
      "items": {
        "$ref": "PolicyArpProxyEntry
      }, 
      "readonly": true, 
      "title": "Array of ARP proxy table entries", 
      "type": "array"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "interface_path": {
      "readonly": true, 
      "title": "Policy path of gateway interface", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

InterfaceArpTable (type)

{
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "InterfaceArpTable", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "edge_path": {
      "description": "Policy path of edge node.", 
      "title": "Policy path of edge node", 
      "type": "string"
    }, 
    "enforcement_point_path": {
      "description": "String Path of the enforcement point.", 
      "title": "Enforcement point path", 
      "type": "string"
    }, 
    "interface_path": {
      "required": true, 
      "title": "The ID of the logical router port", 
      "type": "string"
    }, 
    "last_update_timestamp": {
      "$ref": "EpochMsTimestamp, 
      "readonly": true, 
      "title": "Timestamp when the data was last updated; unset if data source has never updated the data."
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "InterfaceArpEntry
      }, 
      "required": false, 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

InterfaceArpTableInCsvFormat (type)

{
  "extends": {
    "$ref": "CsvListResult
  }, 
  "id": "InterfaceArpTableInCsvFormat", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "file_name": {
      "description": "File name set by HTTP server if API  returns CSV result as a file.", 
      "required": false, 
      "title": "File name", 
      "type": "string"
    }, 
    "last_update_timestamp": {
      "$ref": "EpochMsTimestamp, 
      "readonly": true, 
      "title": "Timestamp when the data was last updated; unset if data source has never updated the data."
    }, 
    "results": {
      "items": {
        "$ref": "InterfaceArpCsvRecord
      }, 
      "required": false, 
      "type": "array"
    }
  }, 
  "type": "object"
}

InterfaceDADState (type)

{
  "additionalProperties": false, 
  "description": "Duplicate address detection status on the interface.", 
  "id": "InterfaceDADState", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "dad_statuses": {
      "description": "Array of DAD status which contains DAD information for IP addresses on the interface.", 
      "items": {
        "$ref": "InterfaceIPv6DADStatus
      }, 
      "readonly": true, 
      "title": "IPv6 DAD status", 
      "type": "array"
    }, 
    "interface_path": {
      "description": "Policy path or realization ID of interface for which IPv6 DAD status is returned.", 
      "readonly": true, 
      "title": "Policy path or realization ID of interface", 
      "type": "string"
    }
  }, 
  "title": "Interface DAD status", 
  "type": "object"
}

InterfaceIPv6DADStatus (type)

{
  "additionalProperties": false, 
  "description": "Duplicate address detection status for IP address on the interface.", 
  "id": "InterfaceIPv6DADStatus", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "edge_paths": {
      "description": "Array of edge nodes on which DAD status is reported for given IP address.", 
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Edge node paths", 
      "type": "array"
    }, 
    "ip_address": {
      "$ref": "IPAddress, 
      "description": "IP address on the port for which DAD status is reported.", 
      "readonly": true, 
      "required": false, 
      "title": "IP address"
    }, 
    "status": {
      "$ref": "DADStatus, 
      "description": "DAD status for IP address on the port.", 
      "readonly": true, 
      "required": false, 
      "title": "DAD Status"
    }
  }, 
  "title": "IPv6 DAD status for Interface", 
  "type": "object"
}

InterfaceSubnet (type)

{
  "additionalProperties": false, 
  "id": "InterfaceSubnet", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "ip_addresses": {
      "items": {
        "$ref": "IPAddress
      }, 
      "required": true, 
      "title": "IP addresses assigned to interface", 
      "type": "array"
    }, 
    "prefix_len": {
      "maximum": 128, 
      "minimum": 1, 
      "required": true, 
      "title": "Subnet prefix length", 
      "type": "int"
    }
  }, 
  "title": "Subnet specification for interface connectivity", 
  "type": "object"
}

IntersiteGatewayConfig (type)

{
  "additionalProperties": false, 
  "description": "Intersite gateway configuration.", 
  "id": "IntersiteGatewayConfig", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "fallback_sites": {
      "description": "Fallback site to be used as new primary site on current primary site failure. Disaster recovery must be initiated via API/UI. Fallback site configuration is supported only for T0 gateway. T1 gateway will follow T0 gateway's primary site during disaster recovery.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Fallback sites", 
      "type": "array"
    }, 
    "intersite_transit_subnet": {
      "default": "169.254.32.0/20", 
      "description": "IPv4 subnet for inter-site transit segment connecting service routers across sites for stretched gateway. For IPv6 link local subnet is auto configured.", 
      "format": "ip-cidr-block", 
      "required": false, 
      "title": "Transit subnet in CIDR format", 
      "type": "string"
    }, 
    "last_admin_active_epoch": {
      "description": "Epoch(in seconds) is auto updated based on system current timestamp when primary locale service is updated. It is used for resolving conflict during site failover. If system clock not in sync then User can optionally override this. New value must be higher than the current value.", 
      "maximum": 4294967295, 
      "required": false, 
      "title": "Epoch of last time admin changing active LocaleServices", 
      "type": "integer"
    }, 
    "primary_site_path": {
      "description": "Primary egress site for gateway. T0/T1 gateway in Active/Standby mode supports stateful services on primary site. In this mode primary site must be set if gateway is stretched to more than one site. For T0 gateway in Active/Active primary site is optional field. If set then secondary site prefers routes learned from primary over locally learned routes. This field is not applicable for T1 gateway with no services.", 
      "required": false, 
      "title": "Primary egress site for gateway.", 
      "type": "string"
    }
  }, 
  "title": "Intersite gateway configuration", 
  "type": "object"
}

IntervalBackupSchedule (type)

{
  "extends": {
    "$ref": "BackupSchedule
  }, 
  "id": "IntervalBackupSchedule", 
  "module_id": "BackupConfiguration", 
  "polymorphic-type-descriptor": {
    "type-identifier": "IntervalBackupSchedule"
  }, 
  "properties": {
    "resource_type": {
      "enum": [
        "WeeklyBackupSchedule", 
        "IntervalBackupSchedule"
      ], 
      "required": true, 
      "title": "Schedule type", 
      "type": "string"
    }, 
    "seconds_between_backups": {
      "default": 3600, 
      "maximum": 86400, 
      "minimum": 300, 
      "title": "Time interval in seconds between two consecutive automated backups", 
      "type": "integer"
    }
  }, 
  "title": "Schedule to specify the interval time at which automated backups need to be taken", 
  "type": "object"
}

InvalidConfigSummary (type)

{
  "additionalProperties": false, 
  "description": "Invalid Configuration details for a category.", 
  "id": "InvalidConfigSummary", 
  "module_id": "GmConfigOnboarding", 
  "properties": {
    "category": {
      "description": "Configuration category representing resources not supported for the federation site configuration onboarding.", 
      "readonly": true, 
      "required": true, 
      "title": "Configuration Category", 
      "type": "string"
    }, 
    "resource_count": {
      "description": "Total resource count for category", 
      "readonly": true, 
      "required": true, 
      "title": "Resource Count", 
      "type": "integer"
    }, 
    "resource_summary_details": {
      "description": "Represents list of resource summaries for a configuration category which are not supported for the federation site configuration onboarding.", 
      "items": {
        "$ref": "ResourceSummaryDetail
      }, 
      "maxItems": 10, 
      "readonly": true, 
      "required": true, 
      "title": "Resource Summary List", 
      "type": "array"
    }
  }, 
  "title": "Invalid Configuration Summary", 
  "type": "object"
}

IpAddressAllocation (type)

{
  "additionalProperties": false, 
  "description": "Allocation parameters for the IP address (e.g. specific IP address) can be specified. Tags, display_name and description attributes are not supported in this release.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "IpAddressAllocation", 
  "module_id": "PolicyIpam", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "allocation_ip": {
      "$ref": "IPAddress, 
      "readonly": true, 
      "title": "Address that is allocated from pool"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Parameters for IP allocation", 
  "type": "object"
}

IpAddressBlock (type)

{
  "additionalProperties": false, 
  "description": "A block of IP addresses defined by a start address and a mask/prefix (network CIDR). An IP block is typically large & allocated to a tenant for automated consumption. An IP block is always a contiguous address space, for example 192.0.0.1/8. An IP block can be further subdivided into subnets called IP block subnets. These IP block subnets can be added to IP pools and used for IP allocation.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "IpAddressBlock", 
  "module_id": "PolicyIpam", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "cidr": {
      "description": "Represents a network address and the prefix length which will be associated with a layer-2 broadcast domain. Support IPv4 and IPv6 CIDR.", 
      "format": "ip-cidr-block", 
      "required": true, 
      "title": "A contiguous IP address space represented by network address and prefix length", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "IP address space represented by network address and prefix", 
  "type": "object"
}

IpAddressInfo (type)

{
  "additionalProperties": false, 
  "id": "IpAddressInfo", 
  "module_id": "Inventory", 
  "properties": {
    "ip_addresses": {
      "items": {
        "$ref": "IPAddress
      }, 
      "readonly": true, 
      "required": true, 
      "title": "IP Addresses of the the virtual network interface, as discovered in the source.", 
      "type": "array"
    }, 
    "source": {
      "enum": [
        "VM_TOOLS"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Source of the ipaddress information.", 
      "type": "string"
    }
  }, 
  "title": "Ipaddress information of the fabric node.", 
  "type": "object"
}

IpAddressPool (type)

{
  "additionalProperties": false, 
  "description": "IpAddressPool is a collection of subnets. The subnets can either be derived from an IpBlock or specified by the user. User can request for IP addresses to be allocated from a pool. When an IP is requested from a pool, the IP that is returned can come from any subnet that belongs to the pool.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "IpAddressPool", 
  "module_id": "PolicyIpam", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ip_release_delay": {
      "description": "Delay in milliseconds, while releasing allocated IP address from IP pool (Default is 2 mins).", 
      "title": "IP address release delay in milliseconds", 
      "type": "integer"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "A collection of IP subnets", 
  "type": "object"
}

IpAddressPoolBlockSubnet (type)

{
  "additionalProperties": false, 
  "description": "This type of subnet allows user to dynamically carve a subnet out of a preconfigured IpAddressBlock. The user must specify the size of the subnet and the IpAddressBlock from which the subnet is to be derived. If the required amount of IP adress space is available in the specified IpAddressBlock, the system automatically configures subnet range.", 
  "extends": {
    "$ref": "IpAddressPoolSubnet
  }, 
  "id": "IpAddressPoolBlockSubnet", 
  "module_id": "PolicyIpam", 
  "polymorphic-type-descriptor": {
    "type-identifier": "IpAddressPoolBlockSubnet"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "auto_assign_gateway": {
      "default": true, 
      "description": "If this property is set to true, the first IP in the range will be reserved for gateway.", 
      "title": "Indicate whether default gateway is to be reserved from the range", 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ip_block_path": {
      "required": true, 
      "title": "The path of the IpAddressBlock from which the subnet is to be created.", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": {
      "$ref": "IpAddressPoolSubnetType, 
      "description": "Specifies whether the IpAddressPoolSubnet is to be carved out of a IpAddressBlock or will be specified by the user", 
      "required": true, 
      "title": "Represents the type of IpAddressPoolSubnet"
    }, 
    "size": {
      "description": "The size parameter is required for subnet creation. It must be specified during creation but cannot be changed later.", 
      "required": true, 
      "title": "Represents the size or number of IP addresses in the subnet", 
      "type": "integer"
    }, 
    "start_ip": {
      "$ref": "IPAddress, 
      "description": "For internal system use Only. Represents start ip address of the subnet from IP block. Subnet ip adddress will start from this ip address.", 
      "required": false, 
      "title": "Represents start ip address of the subnet"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "IpAddressPoolSubnet dynamically carved out of a IpAddressBlock", 
  "type": "object"
}

IpAddressPoolStaticSubnet (type)

{
  "additionalProperties": false, 
  "description": "This type of subnet is statically configured by the user. The user provides the range details and the gateway for the subnet.", 
  "extends": {
    "$ref": "IpAddressPoolSubnet
  }, 
  "id": "IpAddressPoolStaticSubnet", 
  "module_id": "PolicyIpam", 
  "polymorphic-type-descriptor": {
    "type-identifier": "IpAddressPoolStaticSubnet"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "allocation_ranges": {
      "items": {
        "$ref": "IpPoolRange
      }, 
      "required": true, 
      "title": "A collection of IPv4 or IPv6 IP Pool Ranges.", 
      "type": "array"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "cidr": {
      "required": true, 
      "title": "Subnet representation is a network address and prefix length", 
      "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"
    }, 
    "dns_nameservers": {
      "items": {
        "$ref": "IPAddress
      }, 
      "maxItems": 3, 
      "title": "The collection of upto 3 DNS servers for the subnet.", 
      "type": "array", 
      "uniqueItems": true
    }, 
    "dns_suffix": {
      "format": "hostname", 
      "title": "The DNS suffix for the DNS server.", 
      "type": "string"
    }, 
    "gateway_ip": {
      "$ref": "IPAddress, 
      "title": "The default gateway address on a layer-3 router."
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": {
      "$ref": "IpAddressPoolSubnetType, 
      "description": "Specifies whether the IpAddressPoolSubnet is to be carved out of a IpAddressBlock or will be specified by the user", 
      "required": true, 
      "title": "Represents the type of IpAddressPoolSubnet"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "IpAddressPoolSubnet statically configured by a user", 
  "type": "object"
}

IpAddressPoolSubnet (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "description": "IpAddressPoolSubnet can either be carved out of a PolicyBlock or statically specified by the user. In the first case where the subnet is carved out of a IpAddressBlock, the user must specify the ID of the block from which this subnet is to be derived. This block must be pre-created. The subnet range is auto populated by the system. In the second case, the user configures the subnet range directly. No IpAddressBlock is required.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "IpAddressPoolSubnet", 
  "module_id": "PolicyIpam", 
  "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: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": {
      "$ref": "IpAddressPoolSubnetType, 
      "description": "Specifies whether the IpAddressPoolSubnet is to be carved out of a IpAddressBlock or will be specified by the user", 
      "required": true, 
      "title": "Represents the type of IpAddressPoolSubnet"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Abstract class for IpSubnet in a IpAddressPool", 
  "type": "object"
}

IpAddressPoolSubnetType (type)

{
  "additionalProperties": false, 
  "description": "IpAddressPoolSubnet can either be carved out of a PolicyBlock or statically specified. A subnet to be carved out of a IpAddressBlock is of type IpAddressPoolBlockSubnet A subnet statically specified by the user is of type IpAddressPoolStaticSubnet", 
  "enum": [
    "IpAddressPoolBlockSubnet", 
    "IpAddressPoolStaticSubnet"
  ], 
  "id": "IpAddressPoolSubnetType", 
  "module_id": "PolicyIpam", 
  "title": "Type of IpAddressPoolSubnet", 
  "type": "string"
}

IpInfo (type)

{
  "additionalProperties": false, 
  "description": "Only support IP address or subnet. Its type can be of IPv4 or IPv6. It will be converted to subnet when netmask is specified(e.g., 192.168.1.3/24 => 192.168.1.0/24, 2008:12:12:12::2/64 => 2008:12:12:12::/64).", 
  "id": "IpInfo", 
  "module_id": "LiveTrace", 
  "properties": {
    "dst_ip": {
      "$ref": "IPElement, 
      "required": false, 
      "title": "The destination IP address or subnet"
    }, 
    "src_ip": {
      "$ref": "IPElement, 
      "required": false, 
      "title": "The source IP address or subnet"
    }
  }, 
  "type": "object"
}

IpPoolRange (type)

{
  "additionalProperties": false, 
  "description": "A set of IPv4 or IPv6 addresses defined by a start and end address.", 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "IpPoolRange", 
  "module_id": "Ipam", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "end": {
      "$ref": "IPAddress, 
      "required": true, 
      "title": "The end IP Address of the IP Range."
    }, 
    "start": {
      "$ref": "IPAddress, 
      "required": true, 
      "title": "The start IP Address of the IP Range."
    }
  }, 
  "type": "object"
}

Ipv4Header (type)

{
  "additionalProperties": false, 
  "id": "Ipv4Header", 
  "module_id": "Traceflow", 
  "properties": {
    "dst_ip": {
      "$ref": "IPv4Address, 
      "required": false, 
      "title": "The destination ip address."
    }, 
    "flags": {
      "default": 0, 
      "maximum": 8, 
      "minimum": 0, 
      "required": false, 
      "title": "IP flags", 
      "type": "integer"
    }, 
    "protocol": {
      "default": 1, 
      "maximum": 255, 
      "minimum": 0, 
      "required": false, 
      "title": "IP protocol - defaults to ICMP", 
      "type": "integer"
    }, 
    "src_ip": {
      "$ref": "IPv4Address, 
      "required": false, 
      "title": "The source ip address."
    }, 
    "src_subnet_prefix_len": {
      "description": "This is used together with src_ip to calculate dst_ip for broadcast when dst_ip is not given; not used in all other cases.", 
      "maximum": 32, 
      "minimum": 1, 
      "required": false, 
      "title": "source subnet prefix length.", 
      "type": "integer"
    }, 
    "ttl": {
      "default": 64, 
      "maximum": 255, 
      "minimum": 0, 
      "required": false, 
      "title": "Time to live (ttl)", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

Ipv6DadProfile (type)

{
  "additionalProperties": false, 
  "description": "Duplicate address detection profile.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "Ipv6DadProfile", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "dad_mode": {
      "$ref": "DADMode, 
      "default": "LOOSE", 
      "required": false, 
      "title": "DAD Mode"
    }, 
    "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "ns_retries": {
      "default": 3, 
      "description": "Number of Neighbor solicitation packets generated before completing the Duplicate address detection process.", 
      "maximum": 10, 
      "minimum": 0, 
      "required": false, 
      "title": "NS retries count", 
      "type": "integer"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }, 
    "wait_time": {
      "default": 1, 
      "description": "The time duration in seconds, to wait for Neighbor advertisement after sending the Neighbor solicitation message.", 
      "maximum": 60, 
      "minimum": 0, 
      "required": false, 
      "title": "Wait time", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

Ipv6DadProfileListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "Ipv6DadProfileListResult", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "Ipv6DadProfile
      }, 
      "required": true, 
      "title": "Paginated list of Ipv6DadProfile", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

Ipv6Header (type)

{
  "id": "Ipv6Header", 
  "module_id": "Traceflow", 
  "properties": {
    "dst_ip": {
      "$ref": "IPv6Address, 
      "required": false, 
      "title": "The destination ip address."
    }, 
    "hop_limit": {
      "default": 64, 
      "description": "Decremented by 1 by each node that forwards the packets. The packet is discarded if Hop Limit is decremented to zero.", 
      "maximum": 255, 
      "minimum": 0, 
      "required": false, 
      "title": "hop limit", 
      "type": "integer"
    }, 
    "next_header": {
      "default": 58, 
      "maximum": 255, 
      "minimum": 0, 
      "required": false, 
      "title": "Identifies the type of header immediately following the IPv6 header.", 
      "type": "integer"
    }, 
    "src_ip": {
      "$ref": "IPv6Address, 
      "required": false, 
      "title": "The source ip address."
    }
  }, 
  "type": "object"
}

Ipv6NdraProfile (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "Ipv6NdraProfile", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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"
    }, 
    "dns_config": {
      "$ref": "RaDNSConfig, 
      "required": false, 
      "title": "DNS Configurations"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "ra_config": {
      "$ref": "RAConfig, 
      "required": true, 
      "title": "RA Configuration"
    }, 
    "ra_mode": {
      "$ref": "RAMode, 
      "default": "SLAAC_DNS_THROUGH_RA", 
      "required": true, 
      "title": "RA Mode"
    }, 
    "reachable_timer": {
      "default": 0, 
      "description": "Neighbour reachable time duration in milliseconds. A value of 0 means unspecified.", 
      "maximum": 3600000, 
      "minimum": 0, 
      "required": false, 
      "title": "Reachable timer", 
      "type": "integer"
    }, 
    "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"
    }, 
    "retransmit_interval": {
      "default": 1000, 
      "description": "The time, in milliseconds, between retransmitted neighbour solicitation messages. A value of 0 means unspecified.", 
      "maximum": 4294967295, 
      "minimum": 0, 
      "required": false, 
      "title": "Retransmission interval", 
      "type": "integer"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "type": "object"
}

Ipv6NdraProfileListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "Ipv6NdraProfileListResult", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "Ipv6NdraProfile
      }, 
      "required": true, 
      "title": "Paginated list of Ipv6NdraProfile", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

JoinClusterParameters (type)

{
  "additionalProperties": false, 
  "description": "To join a new node to the NSX cluster, issue a JoinCluster API on the new node. The JoinCluster API takes this object as a parameter. Provide the ID of the NSX cluster you want the new node to join and the IP address of one of the nodes already in that cluster. The Cluster Boot Manager running on the new node will then add the new node to the NSX cluster by making a AttachClusterNode REST API call on the node that is already part of the cluster. In order to make a REST API call to the node in the cluster, the Cluster Boot Manager will need username and password of a priviledged user on the node in the cluster. In place of a username and password, Cluster Boot Manager could also use a OAuth token provided. The Cluster Boot Manager needs either the username and password or the OAuth token to make the REST call but not both.", 
  "id": "JoinClusterParameters", 
  "properties": {
    "certficate_sha256_thumbprint": {
      "required": true, 
      "title": "SHA256 Thumbprint of the API certificate of the cluster node", 
      "type": "string"
    }, 
    "cluster_id": {
      "required": true, 
      "title": "UUID of the cluster to join", 
      "type": "string"
    }, 
    "ip_address": {
      "required": true, 
      "title": "IP address of a node already part of the cluster to join", 
      "type": "string"
    }, 
    "password": {
      "required": false, 
      "sensitive": true, 
      "title": "Password of the user on the cluster node", 
      "type": "string"
    }, 
    "port": {
      "default": 443, 
      "maximum": 65535, 
      "minimum": 1, 
      "required": false, 
      "title": "API port on the cluster node", 
      "type": "integer"
    }, 
    "token": {
      "required": false, 
      "sensitive": true, 
      "title": "Limited time OAuth token instead of the username/password", 
      "type": "string"
    }, 
    "username": {
      "required": false, 
      "title": "Username on the cluster node", 
      "type": "string"
    }
  }, 
  "title": "Parameters needed for this node to join the NSX cluster", 
  "type": "object"
}

KeyValuePair (type)

{
  "additionalProperties": false, 
  "id": "KeyValuePair", 
  "module_id": "Common", 
  "properties": {
    "key": {
      "maxLength": 255, 
      "readonly": false, 
      "required": true, 
      "title": "Key", 
      "type": "string"
    }, 
    "value": {
      "maxLength": 255, 
      "readonly": false, 
      "required": true, 
      "title": "Value", 
      "type": "string"
    }
  }, 
  "title": "An arbitrary key-value pair", 
  "type": "object"
}

KnownHostParameter (type)

{
  "additionalProperties": false, 
  "id": "KnownHostParameter", 
  "properties": {
    "host": {
      "$ref": "HostnameOrIPv4Address, 
      "required": true, 
      "title": "Known host hostname or IP address"
    }, 
    "port": {
      "default": 22, 
      "maximum": 65535, 
      "minimum": 1, 
      "title": "Known host port", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

L2AutoRD (type)

{
  "id": "L2AutoRD", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "l2_auto_rd": {
      "title": "Layer 2 auto assigned route distinghusher", 
      "type": "string"
    }, 
    "l2_vni": {
      "title": "Layer 2 Virtual Network Interface", 
      "type": "string"
    }
  }, 
  "title": "Layer 2 Auto assigned Route Distinguisher", 
  "type": "object"
}

L2BridgeEndpointProfile (type)

{
  "additionalProperties": false, 
  "description": "Used to configure L2 Bridge endpoint profile", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "L2BridgeEndpointProfile", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "edge_paths": {
      "description": "List of policy paths to edge nodes. Edge allocation for L2 bridging.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 2, 
      "minItems": 1, 
      "title": "List of path of Edge nodes", 
      "type": "array"
    }, 
    "failover_mode": {
      "default": "PREEMPTIVE", 
      "enum": [
        "PREEMPTIVE", 
        "NON_PREEMPTIVE"
      ], 
      "title": "Failover mode for the edge bridge cluster", 
      "type": "string"
    }, 
    "ha_mode": {
      "default": "ACTIVE_STANDBY", 
      "description": "High avaialability mode can be active-active or active-standby. High availability mode cannot be modified after realization.", 
      "enum": [
        "ACTIVE_STANDBY"
      ], 
      "title": "High availability mode for the edge bridge cluster", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Layer 2 Bridge Endpoint Profile", 
  "type": "object"
}

L2Extension (type)

{
  "additionalProperties": false, 
  "id": "L2Extension", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "l2vpn_path": {
      "deprecated": true, 
      "description": "This property has been deprecated. Please use the property l2vpn_paths for setting the paths of associated L2 VPN session. This property will continue to work as expected to provide backwards compatibility. However, when both l2vpn_path and l2vpn_paths properties are specified, only l2vpn_paths is used.", 
      "required": false, 
      "title": "Policy path of associated L2 VPN session", 
      "type": "string"
    }, 
    "l2vpn_paths": {
      "description": "Policy paths corresponding to the associated L2 VPN sessions", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Policy paths of associated L2 VPN sessions", 
      "type": "array"
    }, 
    "local_egress": {
      "$ref": "LocalEgress, 
      "description": "Local Egress.", 
      "title": "Local Egress"
    }, 
    "tunnel_id": {
      "maximum": 4093, 
      "minimum": 1, 
      "required": false, 
      "title": "Tunnel ID", 
      "type": "int"
    }
  }, 
  "title": "Segment specific L2 VPN configuration", 
  "type": "object"
}

L2ForwarderRemoteMacsPerSite (type)

{
  "additionalProperties": false, 
  "experimental": true, 
  "id": "L2ForwarderRemoteMacsPerSite", 
  "module_id": "AggSvcL2Forwarder", 
  "properties": {
    "remote_active_ips": {
      "description": "Remote active IP addresses.", 
      "items": {
        "$ref": "IPAddress
      }, 
      "readonly": true, 
      "title": "Remote active IPs", 
      "type": "array"
    }, 
    "remote_mac_addresses": {
      "description": "Remote mac addresses.", 
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "title": "Remote mac addresses", 
      "type": "array"
    }, 
    "remote_site": {
      "$ref": "ResourceReference, 
      "description": "Remote site details.", 
      "readonly": true, 
      "required": true, 
      "title": "Remote site"
    }, 
    "remote_standby_ips": {
      "description": "Remote standby IP addresses.", 
      "items": {
        "$ref": "IPAddress
      }, 
      "readonly": true, 
      "title": "Remote standby IPs", 
      "type": "array"
    }, 
    "rtep_group_id": {
      "description": "32 bit unique RTEP group id of the logical switch per site.", 
      "readonly": true, 
      "required": true, 
      "title": "RTEP group id of logical switch per site", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

L2ForwarderStatusPerNode (type)

{
  "additionalProperties": false, 
  "experimental": true, 
  "id": "L2ForwarderStatusPerNode", 
  "module_id": "AggSvcL2Forwarder", 
  "properties": {
    "high_availability_status": {
      "description": "High Availability status of a service router on the edge node.", 
      "enum": [
        "ACTIVE", 
        "STANDBY", 
        "DOWN", 
        "SYNC", 
        "UNKNOWN"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Service router's HA status", 
      "type": "string"
    }, 
    "transport_node": {
      "$ref": "ResourceReference, 
      "description": "Edge node details from where the router status is being retrieved.", 
      "readonly": true, 
      "required": true, 
      "title": "Transport node"
    }
  }, 
  "type": "object"
}

L2L3RuntimeRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "L2L3RuntimeRequestParameters", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "edge_path": {
      "description": "Policy path of edge node. Edge should be member of enforcement point.", 
      "title": "Policy path of edge node", 
      "type": "string"
    }, 
    "enforcement_point_path": {
      "description": "Enforcement point path.", 
      "title": "String Path of the enforcement point", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "L2 L3 connectivity runtime status request parameters", 
  "type": "object"
}

L2TcpMaxSegmentSizeClamping (type)

{
  "additionalProperties": false, 
  "description": "TCP MSS Clamping Direction and Value.", 
  "id": "L2TcpMaxSegmentSizeClamping", 
  "module_id": "PolicyLayer2VPN", 
  "properties": {
    "direction": {
      "default": "BOTH", 
      "description": "Specifies the traffic direction for which to apply MSS Clamping.", 
      "enum": [
        "NONE", 
        "BOTH"
      ], 
      "required": false, 
      "title": "Maximum Segment Size Clamping Direction", 
      "type": "string"
    }, 
    "max_segment_size": {
      "description": "MSS defines the maximum amount of data that a host is willing to accept in a single TCP segment. This field is set in TCP header during connection establishment. To avoid packet fragmentation, you can set this field depending on uplink MTU and VPN overhead. This is an optional field and in case it is left unconfigured, best possible MSS value will be calculated based on effective mtu of uplink interface. Supported MSS range is 108 to 8852.", 
      "maximum": 8860, 
      "minimum": 108, 
      "required": false, 
      "title": "Maximum Segment Size Value", 
      "type": "integer"
    }
  }, 
  "title": "TCP MSS Clamping", 
  "type": "object"
}

L2VPNService (type)

{
  "additionalProperties": false, 
  "description": "L2VPN Service defines if service running as server or client. It also defines all the common properties for the multiple L2VPN Sessions associated with this service.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "L2VPNService", 
  "module_id": "PolicyLayer2VPN", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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"
    }, 
    "enable_hub": {
      "default": false, 
      "description": "This property applies only in SERVER mode. If set to true, traffic from any client will be replicated to all other clients. If set to false, traffic received from clients is only replicated to the local VPN endpoint.", 
      "required": false, 
      "title": "Enable spoke to spoke (client) forwarding via hub (server)", 
      "type": "boolean"
    }, 
    "encap_ip_pool": {
      "description": "IP Pool to allocate local and peer endpoint IPs for L2VpnSession logical tap.", 
      "items": {
        "$ref": "IPv4CIDRBlock
      }, 
      "required": false, 
      "title": "IP Pool for Logical Taps", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "mode": {
      "default": "SERVER", 
      "description": "Specify an L2VPN service mode as SERVER or CLIENT.", 
      "enum": [
        "SERVER", 
        "CLIENT"
      ], 
      "title": "L2VPN Service Mode", 
      "type": "string"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "L2VPN Service", 
  "type": "object"
}

L2VPNSession (type)

{
  "additionalProperties": false, 
  "description": "Defines the tunnel local and peer addresses along with multiple tansport tunnels for redundancy. L2VPNSession belongs to only one L2VPNService.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "L2VPNSession", 
  "module_id": "PolicyLayer2VPN", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "enabled": {
      "default": true, 
      "description": "Enable to extend all the associated segments.", 
      "required": false, 
      "title": "Enable L2VPN session", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "tcp_mss_clamping": {
      "$ref": "L2TcpMaxSegmentSizeClamping, 
      "description": "TCP Maximum Segment Size Clamping Direction and Value. This feature is supported for L2VPN Sessions that are Server mode only.", 
      "title": "TCP MSS Clamping"
    }, 
    "transport_tunnels": {
      "description": "List of transport tunnels for redundancy.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 1, 
      "minItems": 1, 
      "required": true, 
      "title": "List of transport tunnels", 
      "type": "array"
    }, 
    "tunnel_encapsulation": {
      "$ref": "L2VPNTunnelEncapsulation, 
      "description": "Tunnel encapsulation config. This property only applies in CLIENT mode. It is auto-populated from the L2VPNSessionData.", 
      "readonly": true, 
      "required": false, 
      "title": "Tunnel encapsulation config"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "L2VPN Session", 
  "type": "object"
}

L2VPNTunnelEncapsulation (type)

{
  "additionalProperties": false, 
  "description": "L2VPN tunnel encapsulation config.", 
  "id": "L2VPNTunnelEncapsulation", 
  "module_id": "PolicyLayer2VPN", 
  "properties": {
    "local_endpoint_address": {
      "$ref": "IPv4Address, 
      "description": "IP Address of the local tunnel port. This property only applies in CLIENT mode.", 
      "readonly": true, 
      "required": false, 
      "title": "IP Address of the tunnel port"
    }, 
    "peer_endpoint_address": {
      "$ref": "IPv4Address, 
      "description": "IP Address of the peer tunnel port. This property only applies in CLIENT mode.", 
      "readonly": true, 
      "required": false, 
      "title": "IP Address of the peer tunnel port"
    }, 
    "protocol": {
      "default": "GRE", 
      "description": "Encapsulation protocol used by the tunnel.", 
      "enum": [
        "GRE"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Encapsulation protocol", 
      "type": "string"
    }
  }, 
  "title": "L2VPN Tunnel Encapsulation", 
  "type": "object"
}

L2Vpn (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "Contains information necessary to configure L2Vpn.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "L2Vpn", 
  "module_id": "PolicyL2Vpn", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "enabled": {
      "default": true, 
      "description": "Enable to extend all the associated segments.", 
      "required": false, 
      "title": "Enable L2Vpn", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "transport_tunnels": {
      "description": "List of paths referencing transport tunnels.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 1, 
      "minItems": 1, 
      "required": true, 
      "title": "List of paths referencing transport tunnels", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "L2 Virtual Private Network Configuration", 
  "type": "object"
}

L2VpnContext (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "L2Vpn Context provides meta-data information about the parent Tier-0.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "L2VpnContext", 
  "module_id": "PolicyL2Vpn", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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"
    }, 
    "enable_hub": {
      "default": false, 
      "description": "If enabled, the tier-0 acts as a Hub and replicates traffic received from peer to all other peers. If disabled, the tier-0 acts as a Spoke and replicates only the local.", 
      "title": "Enable to act as hub", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "L2Vpn Context", 
  "type": "object"
}

L3Vpn (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "Contains information necessary to configure IPSec VPN.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "L3Vpn", 
  "module_id": "PolicyL3Vpn", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "dh_groups": {
      "description": "Diffie-Hellman group to be used if PFS is enabled. Default group is GROUP14.", 
      "items": {
        "$ref": "PolicyDHGroup
      }, 
      "maxItems": 1, 
      "title": "DH group", 
      "type": "array", 
      "uniqueItems": true
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "enable_perfect_forward_secrecy": {
      "default": true, 
      "description": "If true, perfect forward secrecy (PFS) is enabled.", 
      "title": "Enable perfect forward secrecy", 
      "type": "boolean"
    }, 
    "enabled": {
      "default": true, 
      "description": "Flag to enable L3Vpn. Default is enabled.", 
      "title": "Enable L3Vpn", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ike_digest_algorithms": {
      "description": "Algorithm to be used for message digest during Internet Key Exchange(IKE) negotiation. Default is SHA2_256.", 
      "items": {
        "$ref": "PolicyIKEDigestAlgorithm
      }, 
      "maxItems": 1, 
      "title": "Digest Algorithm for IKE", 
      "type": "array", 
      "uniqueItems": true
    }, 
    "ike_encryption_algorithms": {
      "description": "Algorithm to be used during Internet Key Exchange(IKE) negotiation. Default is AES_128.", 
      "items": {
        "$ref": "PolicyIKEEncryptionAlgorithm
      }, 
      "maxItems": 1, 
      "title": "Encryption algorithm for IKE", 
      "type": "array", 
      "uniqueItems": true
    }, 
    "ike_version": {
      "$ref": "PolicyIKEVersion, 
      "default": "IKE_V2", 
      "description": "IKE protocol version to be used. IKE-Flex will initiate IKE-V2 and responds to both IKE-V1 and IKE-V2.", 
      "title": "IKE version"
    }, 
    "l3vpn_session": {
      "$ref": "L3VpnSession, 
      "required": true, 
      "title": "L3Vpn Session"
    }, 
    "local_address": {
      "$ref": "IPv4Address, 
      "required": true, 
      "title": "IPv4 address of local gateway"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "passphrases": {
      "description": "List of IPSec pre-shared keys used for IPSec authentication. If not specified, the older passphrase values are retained if there are any.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 1, 
      "sensitive": true, 
      "title": "List of IPSec pre-shared keys", 
      "type": "array", 
      "uniqueItems": true
    }, 
    "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"
    }, 
    "remote_private_address": {
      "description": "This field is used to resolve conflicts in case of a remote site being behind NAT as remote public ip address is not enough. If it is not the case the remote public address should be provided here. If not provided, the value of this field is set to remote_public_address.", 
      "title": "Identifier of the remote site", 
      "type": "string"
    }, 
    "remote_public_address": {
      "$ref": "IPv4Address, 
      "required": true, 
      "title": "Public IPv4 address of remote gateway"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "tunnel_digest_algorithms": {
      "description": "Algorithm to be used for message digest during tunnel establishment. Default algorithm is empty.", 
      "items": {
        "$ref": "PolicyTunnelDigestAlgorithm
      }, 
      "maxItems": 1, 
      "title": "Digest Algorithm for Tunnel Establishment", 
      "type": "array", 
      "uniqueItems": true
    }, 
    "tunnel_encryption_algorithms": {
      "description": "Encryption algorithm to encrypt/decrypt the messages exchanged between IPSec VPN initiator and responder during tunnel negotiation. Default is AES_GCM_128.", 
      "items": {
        "$ref": "PolicyTunnelEncryptionAlgorithm
      }, 
      "maxItems": 1, 
      "title": "Encryption algorithm for Tunnel Establishement", 
      "type": "array", 
      "uniqueItems": true
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "L3 Virtual Private Network Configuration", 
  "type": "object"
}

L3VpnContext (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "L3Vpn Context provides the configuration context that different L3Vpns can consume.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "L3VpnContext", 
  "module_id": "PolicyL3Vpn", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "available_local_addresses": {
      "description": "Local gateway IPv4 addresses available for configuration of each L3Vpn.", 
      "items": {
        "$ref": "PolicyIPAddressInfo
      }, 
      "title": "IPv4 addresses of the local gateway", 
      "type": "array", 
      "uniqueItems": true
    }, 
    "bypass_rules": {
      "description": "Bypass L3Vpn rules that will be shared across L3Vpns. Only Bypass action is supported on these L3Vpn rules.", 
      "items": {
        "$ref": "L3VpnRule
      }, 
      "title": "List of Bypass L3VpnRules", 
      "type": "array", 
      "uniqueItems": true
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "enabled": {
      "default": true, 
      "description": "If true, enable L3Vpn Service for given tier-0. Enabling/disabling this service affects all L3Vpns under the given tier-0.", 
      "title": "Enable L3 Virtual Private Network (VPN) service", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ike_log_level": {
      "default": "INFO", 
      "description": "Log level for internet key exchange (IKE).", 
      "enum": [
        "DEBUG", 
        "INFO", 
        "WARN", 
        "ERROR", 
        "EMERGENCY"
      ], 
      "title": "Internet key exchange (IKE) log level", 
      "type": "string"
    }, 
    "label": {
      "description": "Policy path referencing Label. A label is used as a mechanism to group route-based L3Vpns in order to apply edge firewall rules on members' VTIs.", 
      "required": false, 
      "title": "Policy path referencing Label", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "L3Vpn Context", 
  "type": "object"
}

L3VpnRule (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "For policy-based L3Vpn sessions, a rule specifies as its action the vpn tunnel to be used for transit traffic that meets the rule's match criteria.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "L3VpnRule", 
  "module_id": "PolicyL3Vpn", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "action": {
      "default": "PROTECT", 
      "description": "Action to exchange data with or without protection. PROTECT - Allows to exchange data with ipsec protection. Protect rules are defined per L3Vpn. BYPASS - Allows to exchange data without ipsec protection. Bypass rules are defined per L3VpnContext and affects all policy based L3Vpns. Bypass rules are prioritized over protect rules.", 
      "enum": [
        "PROTECT", 
        "BYPASS"
      ], 
      "title": "Action to apply to the traffic transiting through the L3Vpn", 
      "type": "string"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "destinations": {
      "description": "List of remote subnets used in policy-based L3Vpn.", 
      "items": {
        "$ref": "L3VpnSubnet
      }, 
      "maxItems": 128, 
      "minItems": 1, 
      "required": true, 
      "title": "List of remote subnets", 
      "type": "array", 
      "uniqueItems": true
    }, 
    "display_name": {
      "can_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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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 L3VpnRules associated with a single L3Vpn or L3VpnContext.", 
      "required": false, 
      "title": "Sequence number of the L3VpnRule", 
      "type": "int"
    }, 
    "sources": {
      "description": "List of local subnets used in policy-based L3Vpn.", 
      "items": {
        "$ref": "L3VpnSubnet
      }, 
      "maxItems": 128, 
      "minItems": 1, 
      "required": true, 
      "title": "List of local subnets", 
      "type": "array", 
      "uniqueItems": true
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "L3Vpn Rule", 
  "type": "object"
}

L3VpnSession (type) (Deprecated)

{
  "abstract": true, 
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "Contains information about L3Vpn session.", 
  "id": "L3VpnSession", 
  "module_id": "PolicyL3Vpn", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "resource_type"
  }, 
  "properties": {
    "resource_type": {
      "$ref": "L3VpnSessionResourceType, 
      "required": true
    }
  }, 
  "title": "L3Vpn Session", 
  "type": "object"
}

L3VpnSessionResourceType (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "- A Policy Based L3Vpn is a configuration in which protect rules to match local and remote subnet needs to be defined. Tunnel is established for each pair of local and remote subnet defined in protect rules. - A Route Based L3Vpn is more flexible, more powerful and recommended over policy based. IP Tunnel subnet is created and all traffic routed through tunnel subnet (commonly known as VTI) is sent over tunnel. Routes can be learned through BGP. A route based L3Vpn is required when using redundant L3Vpn.", 
  "enum": [
    "PolicyBasedL3VpnSession", 
    "RouteBasedL3VpnSession"
  ], 
  "id": "L3VpnSessionResourceType", 
  "module_id": "PolicyL3Vpn", 
  "title": "Resource type of L3Vpn Session", 
  "type": "string"
}

L3VpnSubnet (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "Used to specify subnets in L3Vpn rule.", 
  "id": "L3VpnSubnet", 
  "module_id": "PolicyL3Vpn", 
  "properties": {
    "subnet": {
      "$ref": "IPv4CIDRBlock, 
      "description": "Subnet used in L3Vpn Rule.", 
      "required": true, 
      "title": "Subnet"
    }
  }, 
  "title": "Subnet used in L3Vpn Rule", 
  "type": "object"
}

L4PolicyLbPersistenceProfile (type)

{
  "additionalProperties": false, 
  "description": "Some applications maintain state and require all relevant connections to be sent to the same server as the application state is not synchronized among servers. Persistence is enabled on a PolicyLbVirtualServer by binding a persistence profile to it.", 
  "extends": {
    "$ref": "PolicyLbPersistenceProfile
  }, 
  "id": "L4PolicyLbPersistenceProfile", 
  "module_id": "TempPolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "L4PolicyLbPersistenceProfile"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "persistence": {
      "default": "SOURCE_IP", 
      "description": "This field indicates the persistence method used for the PolicyLbVirtualServer. - SOURCE_IP persistence ensures all connections from a client (identified by IP address) are sent to the same backend server for a specified period. - This object is not required and persistence is disabled by default", 
      "enum": [
        "SOURCE_IP"
      ], 
      "required": false, 
      "title": "Persistence method used by PolicyLbVirtualServer(s)", 
      "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": [
        "L4PolicyLbPersistenceProfile", 
        "L7PolicyLbPersistenceProfile", 
        "CustomPolicyLbPersistenceProfile"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "PolicyLbPersistenceProflie for L4 type PolicyLbVirtualServer", 
  "type": "object"
}

L4PortSetServiceEntry (type)

{
  "additionalProperties": false, 
  "description": "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\".", 
  "extends": {
    "$ref": "ServiceEntry
  }, 
  "id": "L4PortSetServiceEntry", 
  "module_id": "Policy", 
  "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: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "destination_ports": {
      "description": "Number of values should not exceed 15, ranges count as 2 values.", 
      "items": {
        "$ref": "PortElement
      }, 
      "maxItems": 15, 
      "required": false, 
      "type": "array"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "l4_protocol": {
      "enum": [
        "TCP", 
        "UDP"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": [
        "IPProtocolServiceEntry", 
        "IGMPTypeServiceEntry", 
        "ICMPTypeServiceEntry", 
        "ALGTypeServiceEntry", 
        "L4PortSetServiceEntry", 
        "EtherTypeServiceEntry", 
        "NestedServiceServiceEntry"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "source_ports": {
      "description": "Number of values should not exceed 15, ranges count as 2 values.", 
      "items": {
        "$ref": "PortElement
      }, 
      "maxItems": 15, 
      "required": false, 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "An ServiceEntry that represents TCP or UDP protocol", 
  "type": "object"
}

L7PolicyLbPersistenceProfile (type)

{
  "description": "Some applications maintain state and require all relevant connections to be sent to the same server as the application state is not synchronized among servers. Persistence is enabled on a PolicyLbVirtualServer by binding a persistence profile to it.", 
  "extends": {
    "$ref": "PolicyLbPersistenceProfile
  }, 
  "id": "L7PolicyLbPersistenceProfile", 
  "module_id": "TempPolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "L7PolicyLbPersistenceProfile"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "persistence": {
      "default": "COOKIE", 
      "description": "This field indicates the persistence method used for the PolicyLbVirtualServer. - COOKIE persistence allows related client connections, identified by the same cookie in HTTP requests [Refer to HTTP Cookie for details on HTTP cookies], to be redirected to the same server. Load balancer does not maintain any persistence table for cookie persistence. Instead, it encodes the necessary information in the HTTP cookie value sent to client and relies on the client to store it and send it back in subsequent related HTTP requests. Hence there is no limit on the number of cookie persistence entries that can be supported. - This object is not required and persistence is disabled by default", 
      "enum": [
        "COOKIE"
      ], 
      "required": false, 
      "title": "Persistence method used by PolicyLbVirtualServer(s)", 
      "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": [
        "L4PolicyLbPersistenceProfile", 
        "L7PolicyLbPersistenceProfile", 
        "CustomPolicyLbPersistenceProfile"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "PolicyLbPersistenceProflie for L7 type PolicyLbVirtualServer", 
  "type": "object"
}

LBAccessListControl (type)

{
  "additionalProperties": false, 
  "description": "LBAccessListControl is used to define how IP access list control can filter the connections from clients.", 
  "id": "LBAccessListControl", 
  "module_id": "PolicyLoadBalancer", 
  "properties": {
    "action": {
      "description": "ALLOW means connections matching grouping object IP list are allowed and requests not matching grouping object IP list are dropped. DROP means connections matching grouping object IP list are dropped and requests not matching grouping object IP list are allowed.", 
      "enum": [
        "ALLOW", 
        "DROP"
      ], 
      "required": true, 
      "title": "IP access list control action", 
      "type": "string"
    }, 
    "enabled": {
      "default": false, 
      "description": "The enabled flag indicates whether to enable access list control option. It is false by default.", 
      "required": false, 
      "title": "Whether to enable access list control option", 
      "type": "boolean"
    }, 
    "group_path": {
      "description": "The path of grouping object which defines the IP addresses or ranges to match the client IP.", 
      "required": true, 
      "title": "Grouping object path", 
      "type": "string"
    }
  }, 
  "title": "IP access list control to filter the connections from clients", 
  "type": "object"
}

LBActiveMonitor (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "description": "All the active types of LBMonitorProfile extend from this abstract class. This is present for extensibility.", 
  "extends": {
    "$ref": "LBMonitorProfile
  }, 
  "id": "LBActiveMonitor", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LBActiveMonitor"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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"
    }, 
    "fall_count": {
      "default": 3, 
      "description": "Only if a healthcheck fails consecutively for a specified number of times, given with fall_count, to a member will the member status be marked DOWN.", 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "Monitor fall count for active healthchecks", 
      "type": "integer"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "interval": {
      "default": 5, 
      "description": "Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group.", 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "Monitor interval in seconds for active healthchecks", 
      "type": "integer"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "monitor_port": {
      "description": "Typically, monitors perform healthchecks to Group members using the member IP address and pool_port. However, in some cases, customers prefer to run healthchecks against a different port than the pool member port which handles actual application traffic. In such cases, the port to run healthchecks against can be specified in the monitor_port value. For ICMP monitor, monitor_port is not required.", 
      "maximum": 65535, 
      "minimum": 0, 
      "required": false, 
      "title": "Monitor port for active healthchecks", 
      "type": "int"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": {
      "$ref": "LBMonitorProfileType, 
      "required": true
    }, 
    "rise_count": {
      "default": 3, 
      "description": "Once a member is DOWN, a specified number of consecutive successful healthchecks specified by rise_count will bring the member back to UP state.", 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "Monitor rise count for active healthchecks", 
      "type": "integer"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "timeout": {
      "default": 5, 
      "description": "Timeout specified in seconds.  After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.", 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "Monitor timeout in seconds for active healthchecks", 
      "type": "integer"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Base class for each type of active LBMonitorProfile", 
  "type": "object"
}

LBAppProfile (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "description": "App profile.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "LBAppProfile", 
  "module_id": "PolicyLoadBalancer", 
  "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: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": {
      "$ref": "LBApplicationProfileType, 
      "required": true
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "App profile", 
  "type": "object"
}

LBApplicationProfileType (type)

{
  "additionalProperties": false, 
  "description": "An application profile can be bound to a virtual server to specify the application protocol characteristics. It is used to influence how load balancing is performed. Currently, three types of application profiles are supported: LBFastTCPProfile, LBFastUDPProfile and LBHttpProfile. LBFastTCPProfile or LBFastUDPProfile is typically used when the application is using a custom protocol or a standard protocol not supported by the load balancer. It is also used in cases where the user only wants L4 load balancing mainly because L4 load balancing has much higher performance and scalability, and/or supports connection mirroring. LBHttpProfile is used for both HTTP and HTTPS applications. Though application rules, if bound to the virtual server, can be used to accomplish the same goal, LBHttpProfile is intended to simplify enabling certain common use cases.", 
  "enum": [
    "LBHttpProfile", 
    "LBFastTcpProfile", 
    "LBFastUdpProfile"
  ], 
  "id": "LBApplicationProfileType", 
  "module_id": "PolicyLoadBalancer", 
  "title": "Application profile type", 
  "type": "string"
}

LBClientCertificateIssuerDnCondition (type)

{
  "additionalProperties": false, 
  "description": "Match condition for client certficate issuer DN.", 
  "id": "LBClientCertificateIssuerDnCondition", 
  "module_id": "PolicyLoadBalancer", 
  "properties": {
    "case_sensitive": {
      "default": true, 
      "description": "If true, case is significant when comparing issuer DN value.", 
      "required": false, 
      "title": "A case sensitive flag for issuer DN comparing", 
      "type": "boolean"
    }, 
    "issuer_dn": {
      "description": "Value of issuer DN.", 
      "required": true, 
      "title": "Value of issuer DN", 
      "type": "string"
    }, 
    "match_type": {
      "$ref": "LbRuleMatchType, 
      "default": "REGEX", 
      "description": "Match type of issuer DN.", 
      "required": false, 
      "title": "Match type of issuer DN"
    }
  }, 
  "title": "Match condition for client certficate issuer DN", 
  "type": "object"
}

LBClientCertificateSubjectDnCondition (type)

{
  "additionalProperties": false, 
  "description": "Match condition for client certficate subject DN.", 
  "id": "LBClientCertificateSubjectDnCondition", 
  "module_id": "PolicyLoadBalancer", 
  "properties": {
    "case_sensitive": {
      "default": true, 
      "description": "If true, case is significant when comparing subject DN value.", 
      "required": false, 
      "title": "A case sensitive flag for subject DN comparing", 
      "type": "boolean"
    }, 
    "match_type": {
      "$ref": "LbRuleMatchType, 
      "default": "REGEX", 
      "description": "Match type of subject DN.", 
      "required": false, 
      "title": "Match type of subject DN"
    }, 
    "subject_dn": {
      "description": "Value of subject DN.", 
      "required": true, 
      "title": "Value of subject DN", 
      "type": "string"
    }
  }, 
  "title": "Match condition for client certficate subject DN", 
  "type": "object"
}

LBClientSslProfile (type)

{
  "additionalProperties": false, 
  "description": "Client SSL profile.", 
  "extends": {
    "$ref": "LBSslProfile
  }, 
  "id": "LBClientSslProfile", 
  "module_id": "PolicyLoadBalancer", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "cipher_group_label": {
      "$ref": "SslCipherGroup, 
      "description": "It is a label of cipher group which is mostly consumed by GUI.", 
      "required": false, 
      "title": "Label of cipher group"
    }, 
    "ciphers": {
      "description": "Supported SSL cipher list to client side.", 
      "items": {
        "$ref": "SslCipher
      }, 
      "required": false, 
      "title": "Supported SSL cipher list to client side", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "is_fips": {
      "description": "This flag is set to true when all the ciphers and protocols are FIPS compliant. It is set to false when one of the ciphers or protocols are not FIPS compliant..", 
      "readonly": true, 
      "title": "FIPS compliance of ciphers and protocols", 
      "type": "boolean"
    }, 
    "is_secure": {
      "description": "This flag is set to true when all the ciphers and protocols are secure. It is set to false when one of the ciphers or protocols is insecure.", 
      "readonly": true, 
      "title": "Secure/Insecure SSL profile flag", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "prefer_server_ciphers": {
      "default": true, 
      "description": "During SSL handshake as part of the SSL client Hello client sends an ordered list of ciphers that it can support (or prefers) and typically server selects the first one from the top of that list it can also support. For Perfect Forward Secrecy(PFS), server could override the client's preference.", 
      "required": false, 
      "title": "Prefer server ciphers flag", 
      "type": "boolean"
    }, 
    "protocols": {
      "description": "SSL versions TLS1.1 and TLS1.2 are supported and enabled by default. SSLv2, SSLv3, and TLS1.0 are supported, but disabled by default.", 
      "items": {
        "$ref": "SslProtocol
      }, 
      "required": false, 
      "title": "Supported SSL protocol list to client side", 
      "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"
    }, 
    "session_cache_enabled": {
      "default": true, 
      "description": "SSL session caching allows SSL client and server to reuse previously negotiated security parameters avoiding the expensive public key operation during handshake.", 
      "required": false, 
      "title": "Session cache enable/disable flag", 
      "type": "boolean"
    }, 
    "session_cache_timeout": {
      "default": 300, 
      "description": "Session cache timeout specifies how long the SSL session parameters are held on to and can be reused.", 
      "maximum": 86400, 
      "minimum": 1, 
      "required": false, 
      "title": "SSL session cache timeout value", 
      "type": "integer"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Client SSL profile", 
  "type": "object"
}

LBClientSslProfileBinding (type)

{
  "additionalProperties": false, 
  "description": "Client SSL profile binding.", 
  "id": "LBClientSslProfileBinding", 
  "module_id": "PolicyLoadBalancer", 
  "properties": {
    "certificate_chain_depth": {
      "default": 3, 
      "description": "Authentication depth is used to set the verification depth in the client certificates chain.", 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "The maximum traversal depth of client certificate chain", 
      "type": "integer"
    }, 
    "client_auth": {
      "$ref": "ClientAuthType, 
      "default": "IGNORE", 
      "description": "Client authentication mode.", 
      "required": false, 
      "title": "Client authentication mode"
    }, 
    "client_auth_ca_paths": {
      "description": "If client auth type is REQUIRED, client certificate must be signed by one of the trusted Certificate Authorities (CAs), also referred to as root CAs, whose self signed certificates are specified.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "CA path list to verify client certificate", 
      "type": "array"
    }, 
    "client_auth_crl_paths": {
      "description": "A Certificate Revocation List (CRL) can be specified in the client-side SSL profile binding to disallow compromised client certificates.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "CRL path list to verify client certificate", 
      "type": "array"
    }, 
    "default_certificate_path": {
      "description": "A default certificate should be specified which will be used if the server does not host multiple hostnames on the same IP address or if the client does not support SNI extension.", 
      "required": true, 
      "title": "Default service certificate identifier", 
      "type": "string"
    }, 
    "sni_certificate_paths": {
      "description": "Client-side SSL profile binding allows multiple certificates, for different hostnames, to be bound to the same virtual server.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "SNI certificate path list", 
      "type": "array"
    }, 
    "ssl_profile_path": {
      "description": "Client SSL profile defines reusable, application-independent client side SSL properties.", 
      "required": false, 
      "title": "Client SSL profile path", 
      "type": "string"
    }
  }, 
  "title": "Client SSL profile binding", 
  "type": "object"
}

LBConnectionDropAction (type)

{
  "additionalProperties": false, 
  "description": "This action is used to drop the connections. There is no extra propery in this action. If there is no match condition specified, the connection will be always dropped. This action can be specified at HTTP_ACCESS or HTTP_FORWARDING pahse.", 
  "extends": {
    "$ref": "LBRuleAction
  }, 
  "id": "LBConnectionDropAction", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LBConnectionDropAction"
  }, 
  "properties": {
    "type": {
      "$ref": "LBRuleActionType, 
      "description": "The property identifies the load balancer rule action type.", 
      "required": true, 
      "title": "Type of load balancer rule action"
    }
  }, 
  "title": "Action to drop connections", 
  "type": "object"
}

LBCookiePersistenceProfile (type)

{
  "additionalProperties": false, 
  "description": "Some applications maintain state and require all relevant connections to be sent to the same server as the application state is not synchronized among servers. Persistence is enabled on a LBVirtualServer by binding a persistence profile to it.", 
  "extends": {
    "$ref": "LBPersistenceProfile
  }, 
  "id": "LBCookiePersistenceProfile", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LBCookiePersistenceProfile"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "cookie_domain": {
      "description": "HTTP cookie domain could be configured, only available for insert mode.", 
      "required": false, 
      "title": "Cookie domain", 
      "type": "string"
    }, 
    "cookie_fallback": {
      "default": true, 
      "description": "If fallback is true, once the cookie points to a server that is down (i.e. admin state DISABLED or healthcheck state is DOWN), then a new server is selected by default to handle that request. If fallback is false, it will cause the request to be rejected if cookie points to a server.", 
      "required": false, 
      "title": "Cookie persistence fallback", 
      "type": "boolean"
    }, 
    "cookie_garble": {
      "default": true, 
      "description": "If garble is set to true, cookie value (server IP and port) would be encrypted. If garble is set to false, cookie value would be plain text.", 
      "required": false, 
      "title": "Cookie persistence garble", 
      "type": "boolean"
    }, 
    "cookie_httponly": {
      "default": false, 
      "description": "If cookie httponly flag is true, it prevents a script running in the browser from accessing the cookie. Only available for insert mode.", 
      "required": false, 
      "title": "Cookie httponly flag", 
      "type": "boolean"
    }, 
    "cookie_mode": {
      "$ref": "CookiePersistenceModeType, 
      "default": "INSERT", 
      "description": "Cookie persistence mode.", 
      "required": false, 
      "title": "Cookie persistence mode"
    }, 
    "cookie_name": {
      "default": "NSXLB", 
      "description": "Cookie name.", 
      "required": false, 
      "title": "Cookie name", 
      "type": "string"
    }, 
    "cookie_path": {
      "description": "HTTP cookie path could be set, only available for insert mode.", 
      "required": false, 
      "title": "Cookie path", 
      "type": "string"
    }, 
    "cookie_secure": {
      "default": false, 
      "description": "If cookie secure flag is true, it prevents the browser from sending a cookie over http. The cookie is sent only over https. Only available for insert mode.", 
      "required": false, 
      "title": "Cookie secure flag", 
      "type": "boolean"
    }, 
    "cookie_time": {
      "$ref": "LBCookieTime, 
      "description": "Both session cookie and persistence cookie are supported, if not specified, it's a session cookie. It expires when the browser is closed.", 
      "required": false, 
      "title": "Cookie time setting"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "persistence_shared": {
      "default": false, 
      "description": "Persistence shared setting indicates that all LBVirtualServers that consume this LBPersistenceProfile should share the same persistence mechanism when enabled.  Meaning, persistence entries of a client accessing one virtual server will also affect the same client's connections to a different virtual server. For example, say there are two virtual servers vip-ip1:80 and vip-ip1:8080 bound to the same Group g1 consisting of two servers (s11:80 and s12:80). By default, each virtual server will have its own persistence table or cookie. So, in the earlier example, there will be two tables (vip-ip1:80, p1) and (vip-ip1:8080, p1) or cookies. So, if a client connects to vip1:80 and later connects to vip1:8080, the second connection may be sent to a different server than the first.  When persistence_shared is enabled, then the second connection will always connect to the same server as the original connection. For COOKIE persistence type, the same cookie will be shared by multiple virtual servers. For SOURCE_IP persistence type, the persistence table will be shared across virtual servers. For GENERIC persistence type, the persistence table will be shared across virtual servers which consume the same persistence profile in LBRule actions.", 
      "required": false, 
      "title": "Persistence shared across LBVirtualServers", 
      "type": "boolean"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The resource_type property identifies persistence profile type.", 
      "enum": [
        "LBSourceIpPersistenceProfile", 
        "LBCookiePersistenceProfile", 
        "LBGenericPersistenceProfile"
      ], 
      "required": true, 
      "title": "Persistence profile type", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "LBPersistenceProflie using Cookies for L7 LBVirtualServer", 
  "type": "object"
}

LBCookieTime (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "description": "Cookie time.", 
  "id": "LBCookieTime", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "type"
  }, 
  "properties": {
    "type": {
      "$ref": "LBCookieTimeType, 
      "required": true
    }
  }, 
  "title": "Cookie time", 
  "type": "object"
}

LBCookieTimeType (type)

{
  "additionalProperties": false, 
  "description": "Both session cookie and persistence cookie are supported, Use LbSessionCookieTime for session cookie time setting, Use LbPersistenceCookieTime for persistence cookie time setting", 
  "enum": [
    "LBSessionCookieTime", 
    "LBPersistenceCookieTime"
  ], 
  "id": "LBCookieTimeType", 
  "module_id": "PolicyLoadBalancer", 
  "title": "CookieTime type", 
  "type": "string"
}

LBFastTcpProfile (type)

{
  "additionalProperties": false, 
  "description": "Fast TCP profile.", 
  "extends": {
    "$ref": "LBAppProfile
  }, 
  "id": "LBFastTcpProfile", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LBFastTcpProfile"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "close_timeout": {
      "default": 8, 
      "description": "It is used to specify how long a closing TCP connection (both FINs received or a RST is received) should be kept for this application before cleaning up the connection.", 
      "maximum": 60, 
      "minimum": 1, 
      "required": false, 
      "title": "TCP connection idle timeout in seconds", 
      "type": "integer"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "ha_flow_mirroring_enabled": {
      "default": false, 
      "description": "If flow mirroring is enabled, all the flows to the bounded virtual server are mirrored to the standby node.", 
      "required": false, 
      "title": "Flow mirroring enabled flag", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "idle_timeout": {
      "default": 1800, 
      "description": "It is used to configure how long an idle TCP connection in ESTABLISHED state should be kept for this application before cleaning up.", 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "TCP connection idle timeout in seconds", 
      "type": "integer"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": {
      "$ref": "LBApplicationProfileType, 
      "required": true
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Fast TCP profile", 
  "type": "object"
}

LBFastUdpProfile (type)

{
  "additionalProperties": false, 
  "description": "Fast UDP profile.", 
  "extends": {
    "$ref": "LBAppProfile
  }, 
  "id": "LBFastUdpProfile", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LBFastUdpProfile"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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"
    }, 
    "flow_mirroring_enabled": {
      "default": false, 
      "description": "If flow mirroring is enabled, all the flows to the bounded virtual server are mirrored to the standby node.", 
      "required": false, 
      "title": "Flow mirroring enabled flag", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "idle_timeout": {
      "default": 300, 
      "description": "Though UDP is a connectionless protocol, for the purposes of load balancing, all UDP packets with the same flow signature (source and destination IP/ports and IP protocol) received within the idle timeout period are considered to belong to the same connection and are sent to the same backend server. If no packets are received for idle timeout period, the connection (association between flow signature and the selected server) is cleaned up.", 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "UDP idle timeout in seconds", 
      "type": "integer"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": {
      "$ref": "LBApplicationProfileType, 
      "required": true
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Fast UDP profile", 
  "type": "object"
}

LBGenericPersistenceProfile (type)

{
  "additionalProperties": false, 
  "description": "Some applications maintain state and require all relevant connections to be sent to the same server as the application state is not synchronized among servers. Persistence is enabled on a LBVirtualServer by binding a persistence profile to it. LBGenericPersistenceProfile cannot be attached to virtual server directly, it can be specified in LB rule actions. In HTTP forwarding phase, the profile can be specified in LBVariablePersistenceOnAction. In HTTP response rewriting phase, the profile can be specified in LBVariablePersistenceLearnAction.", 
  "extends": {
    "$ref": "LBPersistenceProfile
  }, 
  "id": "LBGenericPersistenceProfile", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LBGenericPersistenceProfile"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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"
    }, 
    "ha_persistence_mirroring_enabled": {
      "default": false, 
      "description": "The mirroring enabled flag is to synchronize persistence entries. Persistence entries are not synchronized to the HA peer by default.", 
      "required": false, 
      "title": "Mirroring enabled flag", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "persistence_shared": {
      "default": false, 
      "description": "Persistence shared setting indicates that all LBVirtualServers that consume this LBPersistenceProfile should share the same persistence mechanism when enabled.  Meaning, persistence entries of a client accessing one virtual server will also affect the same client's connections to a different virtual server. For example, say there are two virtual servers vip-ip1:80 and vip-ip1:8080 bound to the same Group g1 consisting of two servers (s11:80 and s12:80). By default, each virtual server will have its own persistence table or cookie. So, in the earlier example, there will be two tables (vip-ip1:80, p1) and (vip-ip1:8080, p1) or cookies. So, if a client connects to vip1:80 and later connects to vip1:8080, the second connection may be sent to a different server than the first.  When persistence_shared is enabled, then the second connection will always connect to the same server as the original connection. For COOKIE persistence type, the same cookie will be shared by multiple virtual servers. For SOURCE_IP persistence type, the persistence table will be shared across virtual servers. For GENERIC persistence type, the persistence table will be shared across virtual servers which consume the same persistence profile in LBRule actions.", 
      "required": false, 
      "title": "Persistence shared across LBVirtualServers", 
      "type": "boolean"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The resource_type property identifies persistence profile type.", 
      "enum": [
        "LBSourceIpPersistenceProfile", 
        "LBCookiePersistenceProfile", 
        "LBGenericPersistenceProfile"
      ], 
      "required": true, 
      "title": "Persistence profile type", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "timeout": {
      "default": 300, 
      "description": "When all connections complete (reference count reaches 0), persistence entry timer is started with the expiration time.", 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "Persistence entry expiration time in seconds", 
      "type": "integer"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "LB generic persistence profile", 
  "type": "object"
}

LBHttpMonitorProfile (type)

{
  "additionalProperties": false, 
  "description": "Active healthchecks are disabled by default and can be enabled for a server pool by binding a health monitor to the Group through the LBRule object. This represents active health monitoring over HTTP. Active healthchecks are initiated periodically, at a configurable interval, to each member of the Group. Only if a healthcheck fails consecutively for a specified number of times (fall_count) to a member will the member status be marked DOWN. Once a member is DOWN, a specified number of consecutive successful healthchecks (rise_count) will bring the member back to UP state. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.", 
  "extends": {
    "$ref": "LBActiveMonitor
  }, 
  "id": "LBHttpMonitorProfile", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LBHttpMonitorProfile"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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"
    }, 
    "fall_count": {
      "default": 3, 
      "description": "Only if a healthcheck fails consecutively for a specified number of times, given with fall_count, to a member will the member status be marked DOWN.", 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "Monitor fall count for active healthchecks", 
      "type": "integer"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "interval": {
      "default": 5, 
      "description": "Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group.", 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "Monitor interval in seconds for active healthchecks", 
      "type": "integer"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "monitor_port": {
      "description": "Typically, monitors perform healthchecks to Group members using the member IP address and pool_port. However, in some cases, customers prefer to run healthchecks against a different port than the pool member port which handles actual application traffic. In such cases, the port to run healthchecks against can be specified in the monitor_port value. For ICMP monitor, monitor_port is not required.", 
      "maximum": 65535, 
      "minimum": 0, 
      "required": false, 
      "title": "Monitor port for active healthchecks", 
      "type": "int"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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"
    }, 
    "request_body": {
      "description": "String to send as part of HTTP health check request body. Valid only for certain HTTP methods like POST.", 
      "required": false, 
      "title": "HTTP health check request body", 
      "type": "string"
    }, 
    "request_headers": {
      "description": "Array of HTTP request headers.", 
      "items": {
        "$ref": "LbHttpRequestHeader
      }, 
      "required": false, 
      "title": "Array of HTTP request headers", 
      "type": "array"
    }, 
    "request_method": {
      "$ref": "HttpRequestMethodType, 
      "default": "GET", 
      "description": "The health check method for HTTP monitor type.", 
      "required": false, 
      "title": "The health check method for HTTP monitor type"
    }, 
    "request_url": {
      "default": "/", 
      "description": "For HTTP active healthchecks, the HTTP request url sent can be customized and can include query parameters.", 
      "required": false, 
      "title": "Customized HTTP request url for active health checks", 
      "type": "string"
    }, 
    "request_version": {
      "$ref": "HttpRequestVersionType, 
      "default": "HTTP_VERSION_1_1", 
      "description": "HTTP request version.", 
      "required": false, 
      "title": "HTTP request version"
    }, 
    "resource_type": {
      "$ref": "LBMonitorProfileType, 
      "required": true
    }, 
    "response_body": {
      "description": "If HTTP response body match string (regular expressions not supported) is specified (using LBHttpMonitor.response_body) then the healthcheck HTTP response body is matched against the specified string and server is considered healthy only if there is a match. If the response body string is not specified, HTTP healthcheck is considered successful if the HTTP response status code is 2xx, but it can be configured to accept other status codes as successful.", 
      "required": false, 
      "title": "Response body to match", 
      "type": "string"
    }, 
    "response_status_codes": {
      "description": "The HTTP response status code should be a valid HTTP status code.", 
      "items": {
        "type": "int"
      }, 
      "maxItems": 64, 
      "required": false, 
      "title": "Array of single HTTP response status codes", 
      "type": "array"
    }, 
    "rise_count": {
      "default": 3, 
      "description": "Once a member is DOWN, a specified number of consecutive successful healthchecks specified by rise_count will bring the member back to UP state.", 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "Monitor rise count for active healthchecks", 
      "type": "integer"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "timeout": {
      "default": 5, 
      "description": "Timeout specified in seconds.  After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.", 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "Monitor timeout in seconds for active healthchecks", 
      "type": "integer"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "LBMonitorProfile for active health checks over HTTP", 
  "type": "object"
}

LBHttpProfile (type)

{
  "additionalProperties": false, 
  "description": "Http profile.", 
  "extends": {
    "$ref": "LBAppProfile
  }, 
  "id": "LBHttpProfile", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LBHttpProfile"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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"
    }, 
    "http_redirect_to": {
      "description": "If a website is temporarily down or has moved, incoming requests for that virtual server can be temporarily redirected to a URL.", 
      "required": false, 
      "title": "Http redirect static URL", 
      "type": "string"
    }, 
    "http_redirect_to_https": {
      "default": false, 
      "description": "Certain secure applications may want to force communication over SSL, but instead of rejecting non-SSL connections, they may choose to redirect the client automatically to use SSL.", 
      "required": false, 
      "title": "Flag to indicate whether enable HTTP-HTTPS redirect", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "idle_timeout": {
      "default": 15, 
      "description": "It is used to specify the HTTP application idle timeout, it means that how long the load balancer will keep the connection idle to wait for the client to send the next keep-alive request. It is not a TCP socket setting.", 
      "maximum": 5400, 
      "minimum": 1, 
      "required": false, 
      "title": "HTTP application idle timeout in seconds", 
      "type": "integer"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "ntlm": {
      "deprecated": true, 
      "description": "NTLM is an authentication protocol that can be used over HTTP. If the flag is set to true, LB will use NTLM challenge/response methodology. This property is deprecated. Please use the property server_keep_alive in order to keep the backend server connection alive for the client connection. When create a new profile, if both ntlm and server_keep_alive are set as different values, ERROR will be reported. When update an existing profile, if either ntlm or server_keep_alive value is changed, both of them are updated with the changed value.", 
      "required": false, 
      "title": "NTLM support flag", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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"
    }, 
    "request_body_size": {
      "description": "If it is not specified, it means that request body size is unlimited.", 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "Maximum size of the buffer used to store HTTP request body", 
      "type": "integer"
    }, 
    "request_header_size": {
      "default": 1024, 
      "description": "A request with header equal to or below this size is guaranteed to be processed. A request with header larger than request_header_size will be processed up to 32K bytes on best effort basis.", 
      "minimum": 1, 
      "required": false, 
      "title": "Maximum size of the buffer used to store HTTP request headers", 
      "type": "integer"
    }, 
    "resource_type": {
      "$ref": "LBApplicationProfileType, 
      "required": true
    }, 
    "response_buffering": {
      "default": false, 
      "description": "When buffering is disabled, the response is passed to a client synchronously, immediately as it is received. When buffering is enabled, LB receives a response from the backend server as soon as possible, saving it into the buffers.", 
      "required": false, 
      "title": "Enable or disable buffering of responses", 
      "type": "boolean"
    }, 
    "response_header_size": {
      "default": 4096, 
      "description": "A response with header larger than response_header_size will be dropped.", 
      "maximum": 65536, 
      "minimum": 1, 
      "required": false, 
      "title": "Maximum size of the buffer used to store HTTP response headers", 
      "type": "integer"
    }, 
    "response_timeout": {
      "default": 60, 
      "description": "If server doesn\u2019t send any packet within this time, the connection is closed.", 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "Maximum server idle time in seconds", 
      "type": "integer"
    }, 
    "server_keep_alive": {
      "description": "If server_keep_alive is true, it means the backend connection will keep alive for the client connection. Every client connection is tied 1:1 with the corresponding server-side connection. If server_keep_alive is false, it means the backend connection won't keep alive for the client connection. If server_keep_alive is not specified for API input, its value in API output will be the same with the property ntlm.", 
      "required": false, 
      "title": "Server keep-alive flag", 
      "type": "boolean"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }, 
    "x_forwarded_for": {
      "$ref": "LBXForwardedForType, 
      "description": "When X-Forwareded-For is configured, X-Forwarded-Proto and X-Forwarded-Port information is added automatically. The two additional header information can be also modified or deleted in load balancer rules.", 
      "required": false, 
      "title": "Insert or replace x_forwarded_for"
    }
  }, 
  "title": "Http profile", 
  "type": "object"
}

LBHttpRedirectAction (type)

{
  "additionalProperties": false, 
  "description": "This action is used to redirect HTTP request messages to a new URL. The reply_status value specified in this action is used as the status code of HTTP response message which is sent back to client (Normally a browser). The HTTP status code for redirection is 3xx, for example, 301, 302, 303, 307, etc. The redirect_url is the new URL that the HTTP request message is redirected to. Normally browser will send another HTTP request to the new URL after receiving a redirection response message. Captured variables and built-in variables can be used in redirect_url field. For example, to redirect all HTTP requests to HTTPS requests for a virtual server. We create an LBRule without any conditions, add an LBHttpRedirectAction to the rule. Set the redirect_url field of the LBHttpRedirectAction to:   https://$_host$_request_uri And set redirect_status to \"302\", which means found. This rule will redirect all HTTP requests to HTTPS server port on the same host.", 
  "extends": {
    "$ref": "LBRuleAction
  }, 
  "id": "LBHttpRedirectAction", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LBHttpRedirectAction"
  }, 
  "properties": {
    "redirect_status": {
      "description": "HTTP response status code.", 
      "required": true, 
      "title": "HTTP response status code", 
      "type": "string"
    }, 
    "redirect_url": {
      "description": "The URL that the HTTP request is redirected to.", 
      "required": true, 
      "title": "The URL that the HTTP request is redirected to", 
      "type": "string"
    }, 
    "type": {
      "$ref": "LBRuleActionType, 
      "description": "The property identifies the load balancer rule action type.", 
      "required": true, 
      "title": "Type of load balancer rule action"
    }
  }, 
  "title": "Action to redirect HTTP request messages", 
  "type": "object"
}

LBHttpRejectAction (type)

{
  "additionalProperties": false, 
  "description": "This action is used to reject HTTP request messages. The specified reply_status value is used as the status code for the corresponding HTTP response message which is sent back to client (Normally a browser) indicating the reason it was rejected. Reference official HTTP status code list for your specific HTTP version to set the reply_status properly. LBHttpRejectAction does not support variables.", 
  "extends": {
    "$ref": "LBRuleAction
  }, 
  "id": "LBHttpRejectAction", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LBHttpRejectAction"
  }, 
  "properties": {
    "reply_message": {
      "description": "Response message.", 
      "required": false, 
      "title": "Response message", 
      "type": "string"
    }, 
    "reply_status": {
      "description": "HTTP response status code.", 
      "required": true, 
      "title": "HTTP response status code", 
      "type": "string"
    }, 
    "type": {
      "$ref": "LBRuleActionType, 
      "description": "The property identifies the load balancer rule action type.", 
      "required": true, 
      "title": "Type of load balancer rule action"
    }
  }, 
  "title": "Action to reject HTTP request messages", 
  "type": "object"
}

LBHttpRequestBodyCondition (type)

{
  "additionalProperties": false, 
  "description": "This condition is used to match the message body of an HTTP request. Typically, only HTTP POST, PATCH, or PUT requests have request body. The match_type field defines how body_value field is used to match the body of HTTP requests.", 
  "extends": {
    "$ref": "LBRuleCondition
  }, 
  "id": "LBHttpRequestBodyCondition", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LBHttpRequestBodyCondition"
  }, 
  "properties": {
    "body_value": {
      "required": true, 
      "title": "HTTP request body", 
      "type": "string"
    }, 
    "case_sensitive": {
      "default": true, 
      "description": "If true, case is significant when comparing HTTP body value.", 
      "required": false, 
      "title": "A case sensitive flag for HTTP body comparing", 
      "type": "boolean"
    }, 
    "inverse": {
      "default": false, 
      "required": false, 
      "title": "A flag to indicate whether reverse the match result of this condition", 
      "type": "boolean"
    }, 
    "match_type": {
      "$ref": "LbRuleMatchType, 
      "default": "REGEX", 
      "required": false, 
      "title": "Match type of HTTP body"
    }, 
    "type": {
      "$ref": "LBRuleConditionType, 
      "required": true, 
      "title": "Type of load balancer rule condition"
    }
  }, 
  "title": "Condition to match content of HTTP request message body", 
  "type": "object"
}

LBHttpRequestCookieCondition (type)

{
  "additionalProperties": false, 
  "description": "This condition is used to match HTTP request messages by cookie which is a specific type of HTTP header. The match_type and case_sensitive define how to compare cookie value.", 
  "extends": {
    "$ref": "LBRuleCondition
  }, 
  "id": "LBHttpRequestCookieCondition", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LBHttpRequestCookieCondition"
  }, 
  "properties": {
    "case_sensitive": {
      "default": true, 
      "description": "If true, case is significant when comparing cookie value.", 
      "required": false, 
      "title": "A case sensitive flag for cookie value comparing", 
      "type": "boolean"
    }, 
    "cookie_name": {
      "description": "Cookie name.", 
      "required": true, 
      "title": "Name of cookie", 
      "type": "string"
    }, 
    "cookie_value": {
      "description": "Cookie value.", 
      "required": true, 
      "title": "Value of cookie", 
      "type": "string"
    }, 
    "inverse": {
      "default": false, 
      "required": false, 
      "title": "A flag to indicate whether reverse the match result of this condition", 
      "type": "boolean"
    }, 
    "match_type": {
      "$ref": "LbRuleMatchType, 
      "default": "REGEX", 
      "description": "Match type of cookie value.", 
      "required": false, 
      "title": "Match type of cookie value"
    }, 
    "type": {
      "$ref": "LBRuleConditionType, 
      "required": true, 
      "title": "Type of load balancer rule condition"
    }
  }, 
  "title": "Condition to match HTTP request cookie", 
  "type": "object"
}

LBHttpRequestHeaderCondition (type)

{
  "additionalProperties": false, 
  "description": "This condition is used to match HTTP request messages by HTTP header fields. HTTP header fields are components of the header section of HTTP request and response messages. They define the operating parameters of an HTTP transaction. For example, Cookie, Authorization, User-Agent, etc. One condition can be used to match one header field, to match multiple header fields, multiple conditions must be specified. The match_type field defines how header_value field is used to match HTTP requests. The header_name field does not support match types.", 
  "extends": {
    "$ref": "LBRuleCondition
  }, 
  "id": "LBHttpRequestHeaderCondition", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LBHttpRequestHeaderCondition"
  }, 
  "properties": {
    "case_sensitive": {
      "default": true, 
      "description": "If true, case is significant when comparing HTTP header value.", 
      "required": false, 
      "title": "A case sensitive flag for HTTP header value comparing", 
      "type": "boolean"
    }, 
    "header_name": {
      "default": "Host", 
      "required": false, 
      "title": "Name of HTTP header", 
      "type": "string"
    }, 
    "header_value": {
      "required": true, 
      "title": "Value of HTTP header", 
      "type": "string"
    }, 
    "inverse": {
      "default": false, 
      "required": false, 
      "title": "A flag to indicate whether reverse the match result of this condition", 
      "type": "boolean"
    }, 
    "match_type": {
      "$ref": "LbRuleMatchType, 
      "default": "REGEX", 
      "required": false, 
      "title": "Match type of HTTP header value"
    }, 
    "type": {
      "$ref": "LBRuleConditionType, 
      "required": true, 
      "title": "Type of load balancer rule condition"
    }
  }, 
  "title": "Condition to match HTTP request header", 
  "type": "object"
}

LBHttpRequestHeaderDeleteAction (type)

{
  "additionalProperties": false, 
  "description": "This action is used to delete header fields of HTTP request messages at HTTP_REQUEST_REWRITE phase. One action can be used to delete all headers with same header name. To delete headers with different header names, multiple actions must be defined.", 
  "extends": {
    "$ref": "LBRuleAction
  }, 
  "id": "LBHttpRequestHeaderDeleteAction", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LBHttpRequestHeaderDeleteAction"
  }, 
  "properties": {
    "header_name": {
      "description": "Name of a header field of HTTP request message.", 
      "required": true, 
      "title": "Name of a header field of HTTP request message", 
      "type": "string"
    }, 
    "type": {
      "$ref": "LBRuleActionType, 
      "description": "The property identifies the load balancer rule action type.", 
      "required": true, 
      "title": "Type of load balancer rule action"
    }
  }, 
  "title": "Action to delete HTTP request header fields", 
  "type": "object"
}

LBHttpRequestHeaderRewriteAction (type)

{
  "additionalProperties": false, 
  "description": "This action is used to rewrite header fields of matched HTTP request messages to specified new values. One action can be used to rewrite one header field. To rewrite multiple header fields, multiple actions must be defined. Captured variables and built-in variables can be used in the header_value field, header_name field does not support variables.", 
  "extends": {
    "$ref": "LBRuleAction
  }, 
  "id": "LBHttpRequestHeaderRewriteAction", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LBHttpRequestHeaderRewriteAction"
  }, 
  "properties": {
    "header_name": {
      "description": "Name of HTTP request header.", 
      "required": true, 
      "title": "Name of HTTP request header", 
      "type": "string"
    }, 
    "header_value": {
      "description": "Value of HTTP request header.", 
      "required": true, 
      "title": "Value of HTTP request header", 
      "type": "string"
    }, 
    "type": {
      "$ref": "LBRuleActionType, 
      "description": "The property identifies the load balancer rule action type.", 
      "required": true, 
      "title": "Type of load balancer rule action"
    }
  }, 
  "title": "Action to rewrite header fields of HTTP request messages", 
  "type": "object"
}

LBHttpRequestMethodCondition (type)

{
  "additionalProperties": false, 
  "description": "This condition is used to match method of HTTP requests. If the method of an HTTP request is same as the method specified in this condition, the HTTP request match this condition. For example, if the method field is set to GET in this condition, any HTTP request with GET method matches the condition.", 
  "extends": {
    "$ref": "LBRuleCondition
  }, 
  "id": "LBHttpRequestMethodCondition", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LBHttpRequestMethodCondition"
  }, 
  "properties": {
    "inverse": {
      "default": false, 
      "required": false, 
      "title": "A flag to indicate whether reverse the match result of this condition", 
      "type": "boolean"
    }, 
    "method": {
      "$ref": "HttpRequestMethodType, 
      "required": true, 
      "title": "Type of HTTP request method"
    }, 
    "type": {
      "$ref": "LBRuleConditionType, 
      "required": true, 
      "title": "Type of load balancer rule condition"
    }
  }, 
  "title": "Condition to match method of HTTP request messages", 
  "type": "object"
}

LBHttpRequestUriArgumentsCondition (type)

{
  "additionalProperties": false, 
  "description": "This condition is used to match URI arguments aka query string of Http request messages, for example, in URI http://exaple.com?foo=1&bar=2, the \"foo=1&bar=2\" is the query string containing URI arguments. In an URI scheme, query string is indicated by the first question mark (\"?\") character and terminated by a number sign (\"#\") character or by the end of the URI. The uri_arguments field can be specified as a regular expression(Set match_type to REGEX). For example, \"foo=(?<x>\\d+)\". It matches HTTP requests whose URI arguments containing \"foo\", the value of foo contains only digits. And the value of foo is captured as $x which can be used in LBRuleAction fields which support variables.", 
  "extends": {
    "$ref": "LBRuleCondition
  }, 
  "id": "LBHttpRequestUriArgumentsCondition", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LBHttpRequestUriArgumentsCondition"
  }, 
  "properties": {
    "case_sensitive": {
      "default": true, 
      "description": "If true, case is significant when comparing URI arguments.", 
      "required": false, 
      "title": "A case sensitive flag for URI arguments comparing", 
      "type": "boolean"
    }, 
    "inverse": {
      "default": false, 
      "required": false, 
      "title": "A flag to indicate whether reverse the match result of this condition", 
      "type": "boolean"
    }, 
    "match_type": {
      "$ref": "LbRuleMatchType, 
      "default": "REGEX", 
      "required": false, 
      "title": "Match type of URI arguments"
    }, 
    "type": {
      "$ref": "LBRuleConditionType, 
      "required": true, 
      "title": "Type of load balancer rule condition"
    }, 
    "uri_arguments": {
      "description": "URI arguments, aka query string of URI.", 
      "required": true, 
      "title": "URI arguments", 
      "type": "string"
    }
  }, 
  "title": "Condition to match URI arguments of HTTP requests", 
  "type": "object"
}

LBHttpRequestUriCondition (type)

{
  "additionalProperties": false, 
  "description": "This condition is used to match URIs(Uniform Resource Identifier) of HTTP request messages. The URI field can be specified as a regular expression. If an HTTP request message is requesting an URI which matches specified regular expression, it matches the condition. The syntax of whole URI looks like this: scheme:[//[user[:password]@]host[:port]][/path][?query][#fragment] This condition matches only the path part of entire URI. When match_type field is specified as REGEX, the uri field is used as a regular expression to match URI path of HTTP requests. For example, to match any URI that has \"/image/\" or \"/images/\", uri field can be specified as: \"/image[s]?/\". Named capturing groups can be used in the uri field to capture substrings of matched URIs and store them in variables for use in LBRuleAction. For example, specify uri field as: \"/news/(?<year>\\d+)/(?<month>\\d+)/(?<article>.*)\" If the URI path is /articles/news/2017/06/xyz.html, then substring \"2017\" is captured in variable year, \"06\" is captured in variable month, and \"xyz.html\" is captured in variable article. These variables can then be used in an LBRuleAction field which supports variables, such as uri field of LBHttpRequestUriRewriteAction. For example, set the uri field of LBHttpRequestUriRewriteAction as: \"/articles/news/$year-$month-$article\" Then the URI path /articles/news/2017/06/xyz.html is rewritten to: \"/articles/news/2017-06-xyz.html\"", 
  "extends": {
    "$ref": "LBRuleCondition
  }, 
  "id": "LBHttpRequestUriCondition", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LBHttpRequestUriCondition"
  }, 
  "properties": {
    "case_sensitive": {
      "default": true, 
      "description": "If true, case is significant when comparing URI.", 
      "required": false, 
      "title": "A case sensitive flag for URI comparing", 
      "type": "boolean"
    }, 
    "inverse": {
      "default": false, 
      "required": false, 
      "title": "A flag to indicate whether reverse the match result of this condition", 
      "type": "boolean"
    }, 
    "match_type": {
      "$ref": "LbRuleMatchType, 
      "default": "REGEX", 
      "required": false, 
      "title": "Match type of URI"
    }, 
    "type": {
      "$ref": "LBRuleConditionType, 
      "required": true, 
      "title": "Type of load balancer rule condition"
    }, 
    "uri": {
      "required": true, 
      "title": "A string used to identify resource", 
      "type": "string"
    }
  }, 
  "title": "Condition to match URIs of HTTP request messages", 
  "type": "object"
}

LBHttpRequestUriRewriteAction (type)

{
  "additionalProperties": false, 
  "description": "This action is used to rewrite URIs in matched HTTP request messages. Specify the uri and uri_arguments fields in this condition to rewrite the matched HTTP request message's URI and URI arguments to the new values. Full URI scheme of HTTP messages have following syntax: scheme:[//[user[:password]@]host[:port]][/path][?query][#fragment] The uri field of this action is used to rewrite the /path part in above scheme. And the uri_arguments field is used to rewrite the query part. Captured variables and built-in variables can be used in the uri and uri_arguments fields. Check the example in LBRuleAction to see how to use variables in this action.", 
  "extends": {
    "$ref": "LBRuleAction
  }, 
  "id": "LBHttpRequestUriRewriteAction", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LBHttpRequestUriRewriteAction"
  }, 
  "properties": {
    "type": {
      "$ref": "LBRuleActionType, 
      "description": "The property identifies the load balancer rule action type.", 
      "required": true, 
      "title": "Type of load balancer rule action"
    }, 
    "uri": {
      "description": "URI of HTTP request.", 
      "required": true, 
      "title": "URI of HTTP request", 
      "type": "string"
    }, 
    "uri_arguments": {
      "description": "Query string of URI, typically contains key value pairs, for example: foo1=bar1&foo2=bar2.", 
      "required": false, 
      "title": "URI arguments", 
      "type": "string"
    }
  }, 
  "title": "Action to rewrite HTTP request URIs.", 
  "type": "object"
}

LBHttpRequestVersionCondition (type)

{
  "additionalProperties": false, 
  "description": "This condition is used to match the HTTP protocol version of the HTTP request messages.", 
  "extends": {
    "$ref": "LBRuleCondition
  }, 
  "id": "LBHttpRequestVersionCondition", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LBHttpRequestVersionCondition"
  }, 
  "properties": {
    "inverse": {
      "default": false, 
      "required": false, 
      "title": "A flag to indicate whether reverse the match result of this condition", 
      "type": "boolean"
    }, 
    "type": {
      "$ref": "LBRuleConditionType, 
      "required": true, 
      "title": "Type of load balancer rule condition"
    }, 
    "version": {
      "$ref": "HttpRequestVersionType, 
      "required": true, 
      "title": "HTTP version"
    }
  }, 
  "title": "Condition to match HTTP protocol version of HTTP requests", 
  "type": "object"
}

LBHttpResponseHeaderCondition (type)

{
  "additionalProperties": false, 
  "description": "This condition is used to match HTTP response messages from backend servers by HTTP header fields. HTTP header fields are components of the header section of HTTP request and response messages. They define the operating parameters of an HTTP transaction. For example, Cookie, Authorization, User-Agent, etc. One condition can be used to match one header field, to match multiple header fields, multiple conditions must be specified. The match_type field defines how header_value field is used to match HTTP responses. The header_name field does not support match types.", 
  "extends": {
    "$ref": "LBRuleCondition
  }, 
  "id": "LBHttpResponseHeaderCondition", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LBHttpResponseHeaderCondition"
  }, 
  "properties": {
    "case_sensitive": {
      "default": true, 
      "description": "If true, case is significant when comparing HTTP header value.", 
      "required": false, 
      "title": "A case sensitive flag for HTTP header value comparing", 
      "type": "boolean"
    }, 
    "header_name": {
      "required": true, 
      "title": "Name of HTTP header field", 
      "type": "string"
    }, 
    "header_value": {
      "required": true, 
      "title": "Value of HTTP header field", 
      "type": "string"
    }, 
    "inverse": {
      "default": false, 
      "required": false, 
      "title": "A flag to indicate whether reverse the match result of this condition", 
      "type": "boolean"
    }, 
    "match_type": {
      "$ref": "LbRuleMatchType, 
      "default": "REGEX", 
      "required": false, 
      "title": "Match type of HTTP header value"
    }, 
    "type": {
      "$ref": "LBRuleConditionType, 
      "required": true, 
      "title": "Type of load balancer rule condition"
    }
  }, 
  "title": "Condition to match a header field of HTTP response", 
  "type": "object"
}

LBHttpResponseHeaderDeleteAction (type)

{
  "additionalProperties": false, 
  "description": "This action is used to delete header fields of HTTP response messages at HTTP_RESPONSE_REWRITE phase. One action can be used to delete allgi headers with same header name. To delete headers with different header names, multiple actions must be defined.", 
  "extends": {
    "$ref": "LBRuleAction
  }, 
  "id": "LBHttpResponseHeaderDeleteAction", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LBHttpResponseHeaderDeleteAction"
  }, 
  "properties": {
    "header_name": {
      "description": "Name of a header field of HTTP response message.", 
      "required": true, 
      "title": "Name of a header field of HTTP response message", 
      "type": "string"
    }, 
    "type": {
      "$ref": "LBRuleActionType, 
      "description": "The property identifies the load balancer rule action type.", 
      "required": true, 
      "title": "Type of load balancer rule action"
    }
  }, 
  "title": "Action to delete HTTP response header fields", 
  "type": "object"
}

LBHttpResponseHeaderRewriteAction (type)

{
  "additionalProperties": false, 
  "description": "This action is used to rewrite header fields of HTTP response messages to specified new values at HTTP_RESPONSE_REWRITE phase. One action can be used to rewrite one header field. To rewrite multiple header fields, multiple actions must be defined. Captured variables and built-in variables can be used in the header_value field, header_name field does not support variables.", 
  "extends": {
    "$ref": "LBRuleAction
  }, 
  "id": "LBHttpResponseHeaderRewriteAction", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LBHttpResponseHeaderRewriteAction"
  }, 
  "properties": {
    "header_name": {
      "description": "Name of a header field of HTTP request message.", 
      "required": true, 
      "title": "Name of a header field of HTTP request message", 
      "type": "string"
    }, 
    "header_value": {
      "description": "Value of header field", 
      "required": true, 
      "title": "Value of header field", 
      "type": "string"
    }, 
    "type": {
      "$ref": "LBRuleActionType, 
      "description": "The property identifies the load balancer rule action type.", 
      "required": true, 
      "title": "Type of load balancer rule action"
    }
  }, 
  "title": "Action to rewrite HTTP response header fields", 
  "type": "object"
}

LBHttpSslCondition (type)

{
  "additionalProperties": false, 
  "description": "This condition is used to match SSL handshake and SSL connection at all phases.If multiple properties are configured, the rule is considered a match when all the configured properties are matched.", 
  "extends": {
    "$ref": "LBRuleCondition
  }, 
  "id": "LBHttpSslCondition", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LBHttpSslCondition"
  }, 
  "properties": {
    "client_certificate_issuer_dn": {
      "$ref": "LBClientCertificateIssuerDnCondition, 
      "description": "The issuer DN match condition of the client certificate for an established SSL connection.", 
      "required": false, 
      "title": "The issuer DN match condition of the client certificate"
    }, 
    "client_certificate_subject_dn": {
      "$ref": "LBClientCertificateSubjectDnCondition, 
      "description": "The subject DN match condition of the client certificate for an established SSL connection.", 
      "required": false, 
      "title": "The subject DN match condition of the client certificate"
    }, 
    "client_supported_ssl_ciphers": {
      "description": "Cipher list which supported by client.", 
      "items": {
        "$ref": "SslCipher
      }, 
      "required": false, 
      "title": "Cipher list which supported by client", 
      "type": "array"
    }, 
    "inverse": {
      "default": false, 
      "required": false, 
      "title": "A flag to indicate whether reverse the match result of this condition", 
      "type": "boolean"
    }, 
    "session_reused": {
      "$ref": "LbSslSessionReusedType, 
      "default": "IGNORE", 
      "description": "The type of SSL session reused.", 
      "required": false, 
      "title": "The type of SSL session reused"
    }, 
    "type": {
      "$ref": "LBRuleConditionType, 
      "required": true, 
      "title": "Type of load balancer rule condition"
    }, 
    "used_protocol": {
      "$ref": "SslProtocol, 
      "description": "Protocol of an established SSL connection.", 
      "required": false, 
      "title": "Protocol of an established SSL connection"
    }, 
    "used_ssl_cipher": {
      "$ref": "SslCipher, 
      "description": "Cipher used for an established SSL connection.", 
      "required": false, 
      "title": "Cipher used for an established SSL connection"
    }
  }, 
  "title": "Condition to match SSL handshake and SSL connection", 
  "type": "object"
}

LBHttpsMonitorProfile (type)

{
  "additionalProperties": false, 
  "description": "Active healthchecks are disabled by default and can be enabled for a server pool by binding a health monitor to the Group through the LBRule object. This represents active health monitoring over HTTPS. Active healthchecks are initiated periodically, at a configurable interval, to each member of the Group. Only if a healthcheck fails consecutively for a specified number of times (fall_count) to a member will the member status be marked DOWN. Once a member is DOWN, a specified number of consecutive successful healthchecks (rise_count) will bring the member back to UP state. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.", 
  "extends": {
    "$ref": "LBActiveMonitor
  }, 
  "id": "LBHttpsMonitorProfile", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LBHttpsMonitorProfile"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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"
    }, 
    "fall_count": {
      "default": 3, 
      "description": "Only if a healthcheck fails consecutively for a specified number of times, given with fall_count, to a member will the member status be marked DOWN.", 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "Monitor fall count for active healthchecks", 
      "type": "integer"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "interval": {
      "default": 5, 
      "description": "Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group.", 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "Monitor interval in seconds for active healthchecks", 
      "type": "integer"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "monitor_port": {
      "description": "Typically, monitors perform healthchecks to Group members using the member IP address and pool_port. However, in some cases, customers prefer to run healthchecks against a different port than the pool member port which handles actual application traffic. In such cases, the port to run healthchecks against can be specified in the monitor_port value. For ICMP monitor, monitor_port is not required.", 
      "maximum": 65535, 
      "minimum": 0, 
      "required": false, 
      "title": "Monitor port for active healthchecks", 
      "type": "int"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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"
    }, 
    "request_body": {
      "description": "String to send as part of HTTP health check request body. Valid only for certain HTTP methods like POST.", 
      "required": false, 
      "title": "HTTP health check request body", 
      "type": "string"
    }, 
    "request_headers": {
      "description": "Array of HTTP request headers.", 
      "items": {
        "$ref": "LbHttpRequestHeader
      }, 
      "required": false, 
      "title": "Array of HTTP request headers", 
      "type": "array"
    }, 
    "request_method": {
      "$ref": "HttpRequestMethodType, 
      "default": "GET", 
      "description": "The health check method for HTTP monitor type.", 
      "required": false, 
      "title": "The health check method for HTTP monitor type"
    }, 
    "request_url": {
      "default": "/", 
      "description": "For HTTPS active healthchecks, the HTTPS request url sent can be customized and can include query parameters.", 
      "required": false, 
      "title": "Customized HTTPS request url for active health checks", 
      "type": "string"
    }, 
    "request_version": {
      "$ref": "HttpRequestVersionType, 
      "default": "HTTP_VERSION_1_1", 
      "description": "HTTP request version.", 
      "required": false, 
      "title": "HTTP request version"
    }, 
    "resource_type": {
      "$ref": "LBMonitorProfileType, 
      "required": true
    }, 
    "response_body": {
      "description": "If HTTP response body match string (regular expressions not supported) is specified (using LBHttpMonitor.response_body) then the healthcheck HTTP response body is matched against the specified string and server is considered healthy only if there is a match. If the response body string is not specified, HTTP healthcheck is considered successful if the HTTP response status code is 2xx, but it can be configured to accept other status codes as successful.", 
      "required": false, 
      "title": "Response body to match", 
      "type": "string"
    }, 
    "response_status_codes": {
      "description": "The HTTP response status code should be a valid HTTP status code.", 
      "items": {
        "type": "int"
      }, 
      "maxItems": 64, 
      "required": false, 
      "title": "Array of single HTTP response status codes", 
      "type": "array"
    }, 
    "rise_count": {
      "default": 3, 
      "description": "Once a member is DOWN, a specified number of consecutive successful healthchecks specified by rise_count will bring the member back to UP state.", 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "Monitor rise count for active healthchecks", 
      "type": "integer"
    }, 
    "server_ssl_profile_binding": {
      "$ref": "LBServerSslProfileBinding, 
      "description": "The setting is used when the monitor acts as an SSL client and establishing a connection to the backend server.", 
      "required": false, 
      "title": "Pool side SSL binding setting"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "timeout": {
      "default": 5, 
      "description": "Timeout specified in seconds.  After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.", 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "Monitor timeout in seconds for active healthchecks", 
      "type": "integer"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "LBMonitorProfile for active health checks over HTTPS", 
  "type": "object"
}

LBIcmpMonitorProfile (type)

{
  "additionalProperties": false, 
  "description": "Active healthchecks are disabled by default and can be enabled for a server pool by binding a health monitor to the Group through the LBRule object. This represents active health monitoring over ICMP. Active healthchecks are initiated periodically, at a configurable interval, to each member of the Group. Only if a healthcheck fails consecutively for a specified number of times (fall_count) to a member will the member status be marked DOWN. Once a member is DOWN, a specified number of consecutive successful healt hchecks (rise_count) will bring the member back to UP state. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.", 
  "extends": {
    "$ref": "LBActiveMonitor
  }, 
  "id": "LBIcmpMonitorProfile", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LBIcmpMonitorProfile"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "data_length": {
      "default": 56, 
      "maximum": 65507, 
      "minimum": 0, 
      "required": false, 
      "title": "The data size (in byte) of the ICMP healthcheck packet", 
      "type": "integer"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "fall_count": {
      "default": 3, 
      "description": "Only if a healthcheck fails consecutively for a specified number of times, given with fall_count, to a member will the member status be marked DOWN.", 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "Monitor fall count for active healthchecks", 
      "type": "integer"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "interval": {
      "default": 5, 
      "description": "Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group.", 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "Monitor interval in seconds for active healthchecks", 
      "type": "integer"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "monitor_port": {
      "description": "Typically, monitors perform healthchecks to Group members using the member IP address and pool_port. However, in some cases, customers prefer to run healthchecks against a different port than the pool member port which handles actual application traffic. In such cases, the port to run healthchecks against can be specified in the monitor_port value. For ICMP monitor, monitor_port is not required.", 
      "maximum": 65535, 
      "minimum": 0, 
      "required": false, 
      "title": "Monitor port for active healthchecks", 
      "type": "int"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": {
      "$ref": "LBMonitorProfileType, 
      "required": true
    }, 
    "rise_count": {
      "default": 3, 
      "description": "Once a member is DOWN, a specified number of consecutive successful healthchecks specified by rise_count will bring the member back to UP state.", 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "Monitor rise count for active healthchecks", 
      "type": "integer"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "timeout": {
      "default": 5, 
      "description": "Timeout specified in seconds.  After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.", 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "Monitor timeout in seconds for active healthchecks", 
      "type": "integer"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "LBMonitorProfile for active health checks over ICMP", 
  "type": "object"
}

LBIpHeaderCondition (type)

{
  "additionalProperties": false, 
  "description": "This condition is used to match IP header fields of HTTP messages. Either source_address or group_id should be specified.", 
  "extends": {
    "$ref": "LBRuleCondition
  }, 
  "id": "LBIpHeaderCondition", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LBIpHeaderCondition"
  }, 
  "properties": {
    "group_path": {
      "description": "Source IP address of HTTP message should match IP addresses which are configured in Group in order to perform actions.", 
      "required": false, 
      "title": "Grouping object path", 
      "type": "string"
    }, 
    "inverse": {
      "default": false, 
      "required": false, 
      "title": "A flag to indicate whether reverse the match result of this condition", 
      "type": "boolean"
    }, 
    "source_address": {
      "$ref": "IPElement, 
      "description": "Source IP address of HTTP message. IP Address can be expressed as a single IP address like 10.1.1.1, or a range of IP addresses like 10.1.1.101-10.1.1.160. Both IPv4 and IPv6 addresses are supported.", 
      "required": false, 
      "title": "Source IP address of HTTP message"
    }, 
    "type": {
      "$ref": "LBRuleConditionType, 
      "required": true, 
      "title": "Type of load balancer rule condition"
    }
  }, 
  "title": "Condition to match IP header fields", 
  "type": "object"
}

LBJwtAuthAction (type)

{
  "additionalProperties": false, 
  "description": "This action is used to control access to backend server resources using JSON Web Token(JWT) authentication. The JWT authentication is done before any HTTP manipulation if the HTTP request matches the given condition in LBRule. Any verification failed, the HTTP process will be terminated, and HTTP response with 401 status code and WWW-Authentication header will be returned to client.", 
  "extends": {
    "$ref": "LBRuleAction
  }, 
  "id": "LBJwtAuthAction", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LBJwtAuthAction"
  }, 
  "properties": {
    "key": {
      "$ref": "LBJwtKey, 
      "descrption": "Keys are used for verifying the signature of JWT token. In current\nversion, only symmetric (HMAC SHA256) key and asymmetric (RS256) key\nare supported. It is optional, in case no key specified, the jwt\nsignature won't be verified.\n", 
      "required": false, 
      "title": "LBJwtKey used for verifying the signature of JWT token"
    }, 
    "pass_jwt_to_pool": {
      "default": false, 
      "description": "Specify whether to pass the JWT to backend server or remove it. By default, it is false which means will not pass the JWT to backend servers.", 
      "required": false, 
      "title": "Whether to pass the JWT to backend server or remove it", 
      "type": "boolean"
    }, 
    "realm": {
      "description": "A description of the protected area. If no realm is specified, clients often display a formatted hostname instead. The configured realm is returned when client request is rejected with 401 http status. In the response, it will be \"WWW-Authentication: Bearer realm=<realm>\".", 
      "required": false, 
      "title": "JWT realm", 
      "type": "string"
    }, 
    "tokens": {
      "description": "JWT is an open standard that defines a compact and self-contained way for securely transmitting information between parties as a JSON object. Load balancer will search for every specified tokens one by one for the jwt message until found. This parameter is optional. In case not found or this field is not configured, load balancer searches the Bearer header by default in the http request \"Authorization: Bearer <token>\".", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "JWT tokens", 
      "type": "array"
    }, 
    "type": {
      "$ref": "LBRuleActionType, 
      "description": "The property identifies the load balancer rule action type.", 
      "required": true, 
      "title": "Type of load balancer rule action"
    }
  }, 
  "title": "Action to control access using JWT authentication", 
  "type": "object"
}

LBJwtCertificateKey (type)

{
  "additionalProperties": false, 
  "description": "The key is used to specify certificate which is used to verify the signature of JWT tokens.", 
  "extends": {
    "$ref": "LBJwtKey
  }, 
  "id": "LBJwtCertificateKey", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LBJwtCertificateKey"
  }, 
  "properties": {
    "certificate_path": {
      "required": true, 
      "title": "Certificate identifier", 
      "type": "string"
    }, 
    "type": {
      "$ref": "LBJwtKeyType, 
      "description": "The property is used to identify JWT key type.", 
      "required": true, 
      "title": "Type of load balancer JWT key"
    }
  }, 
  "title": "Specifies certificate used to verify the signature of JWT tokens", 
  "type": "object"
}

LBJwtKey (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "description": "LBJwtKey specifies the symmetric key or asymmetric public key used to decrypt the data in JWT.", 
  "id": "LBJwtKey", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "type"
  }, 
  "properties": {
    "type": {
      "$ref": "LBJwtKeyType, 
      "description": "The property is used to identify JWT key type.", 
      "required": true, 
      "title": "Type of load balancer JWT key"
    }
  }, 
  "title": "Load balancer JWT key", 
  "type": "object"
}

LBJwtKeyType (type)

{
  "additionalProperties": false, 
  "description": "It is used to identify JWT key type.", 
  "enum": [
    "LBJwtCertificateKey", 
    "LBJwtSymmetricKey", 
    "LBJwtPublicKey"
  ], 
  "id": "LBJwtKeyType", 
  "module_id": "PolicyLoadBalancer", 
  "title": "Type of load balancer JWT key", 
  "type": "string"
}

LBJwtPublicKey (type)

{
  "additionalProperties": false, 
  "description": "The key is used to specify the public key content which is used to verify the signature of JWT tokens.", 
  "extends": {
    "$ref": "LBJwtKey
  }, 
  "id": "LBJwtPublicKey", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LBJwtPublicKey"
  }, 
  "properties": {
    "public_key_content": {
      "required": true, 
      "title": "Content of public key", 
      "type": "string"
    }, 
    "type": {
      "$ref": "LBJwtKeyType, 
      "description": "The property is used to identify JWT key type.", 
      "required": true, 
      "title": "Type of load balancer JWT key"
    }
  }, 
  "title": "Specifies public key content used to verify the signature of JWT tokens", 
  "type": "object"
}

LBJwtSymmetricKey (type)

{
  "additionalProperties": false, 
  "description": "The key is used to specify the symmetric key which is used to verify the signature of JWT tokens.", 
  "extends": {
    "$ref": "LBJwtKey
  }, 
  "id": "LBJwtSymmetricKey", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LBJwtSymmetricKey"
  }, 
  "properties": {
    "type": {
      "$ref": "LBJwtKeyType, 
      "description": "The property is used to identify JWT key type.", 
      "required": true, 
      "title": "Type of load balancer JWT key"
    }
  }, 
  "title": "Specifies the symmetric key used to verify the signature of JWT tokens", 
  "type": "object"
}

LBMonitorProfile (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "LBMonitorProfile", 
  "module_id": "PolicyLoadBalancer", 
  "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: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": {
      "$ref": "LBMonitorProfileType, 
      "required": true
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "type": "object"
}

LBMonitorProfileType (type)

{
  "description": "There are two types of healthchecks: active and passive. Passive healthchecks depend on failures in actual client traffic (e.g. RST from server in response to a client connection) to detect that the server or the application is down. In case of active healthchecks, load balancer itself initiates new connections (or sends ICMP ping) to the servers periodically to check their health, completely independent of any data traffic. Currently, active health monitors are supported for HTTP, HTTPS, TCP, UDP and ICMP protocols.", 
  "enum": [
    "LBTcpMonitorProfile", 
    "LBUdpMonitorProfile", 
    "LBIcmpMonitorProfile", 
    "LBHttpMonitorProfile", 
    "LBHttpsMonitorProfile", 
    "LBPassiveMonitorProfile"
  ], 
  "id": "LBMonitorProfileType", 
  "module_id": "PolicyLoadBalancer", 
  "title": "Monitor type", 
  "type": "string"
}

LBPassiveMonitorProfile (type)

{
  "additionalProperties": false, 
  "description": "The passive type of LBMonitorProfile.", 
  "extends": {
    "$ref": "LBMonitorProfile
  }, 
  "id": "LBPassiveMonitorProfile", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LBPassiveMonitorProfile"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "max_fails": {
      "default": 5, 
      "description": "When the consecutive failures reach this value, then the member is considered temporarily unavailable for a configurable period", 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "Number of consecutive connection failures", 
      "type": "integer"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": {
      "$ref": "LBMonitorProfileType, 
      "required": true
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "timeout": {
      "default": 5, 
      "description": "After this timeout period, the member is tried again for a new connection to see if it is available.", 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "Timeout in seconds before it is selected again for a new connection", 
      "type": "integer"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Base class for each type of active LBMonitorProfile", 
  "type": "object"
}

LBPersistenceCookieTime (type)

{
  "additionalProperties": false, 
  "description": "Persistence cookie time.", 
  "extends": {
    "$ref": "LBCookieTime
  }, 
  "id": "LBPersistenceCookieTime", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LBPersistenceCookieTime"
  }, 
  "properties": {
    "cookie_max_idle": {
      "description": "HTTP cookie max-age to expire cookie, only available for insert mode.", 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": true, 
      "title": "Persistence cookie max idle time in seconds", 
      "type": "integer"
    }, 
    "type": {
      "$ref": "LBCookieTimeType, 
      "required": true
    }
  }, 
  "title": "Persistence cookie time", 
  "type": "object"
}

LBPersistenceProfile (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "description": "Some applications maintain state and require all relevant connections to be sent to the same server as the application state is not synchronized among servers. Persistence is enabled on a LBVirtualServer by binding a persistence profile to it. LBGenericPersistenceProfile cannot be attached to LBVirtualServer directly, it can be specified in LBVariablePersistenceOnAction or LBVariablePersistenceLearnAction in LBRule. If a user attaches a LBGenericPersistenceProfile directly to a virtual server, the operation is rejected.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "LBPersistenceProfile", 
  "module_id": "PolicyLoadBalancer", 
  "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: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "persistence_shared": {
      "default": false, 
      "description": "Persistence shared setting indicates that all LBVirtualServers that consume this LBPersistenceProfile should share the same persistence mechanism when enabled.  Meaning, persistence entries of a client accessing one virtual server will also affect the same client's connections to a different virtual server. For example, say there are two virtual servers vip-ip1:80 and vip-ip1:8080 bound to the same Group g1 consisting of two servers (s11:80 and s12:80). By default, each virtual server will have its own persistence table or cookie. So, in the earlier example, there will be two tables (vip-ip1:80, p1) and (vip-ip1:8080, p1) or cookies. So, if a client connects to vip1:80 and later connects to vip1:8080, the second connection may be sent to a different server than the first.  When persistence_shared is enabled, then the second connection will always connect to the same server as the original connection. For COOKIE persistence type, the same cookie will be shared by multiple virtual servers. For SOURCE_IP persistence type, the persistence table will be shared across virtual servers. For GENERIC persistence type, the persistence table will be shared across virtual servers which consume the same persistence profile in LBRule actions.", 
      "required": false, 
      "title": "Persistence shared across LBVirtualServers", 
      "type": "boolean"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The resource_type property identifies persistence profile type.", 
      "enum": [
        "LBSourceIpPersistenceProfile", 
        "LBCookiePersistenceProfile", 
        "LBGenericPersistenceProfile"
      ], 
      "required": true, 
      "title": "Persistence profile type", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Contains the information related to load balancer persistence options", 
  "type": "object"
}

LBPool (type)

{
  "additionalProperties": false, 
  "description": "Defining access of a Group from a LBVirtualServer and binding to LBMonitorProfile.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "LBPool", 
  "module_id": "PolicyLoadBalancer", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "active_monitor_paths": {
      "description": "In case of active healthchecks, load balancer itself initiates new connections (or sends ICMP ping) to the servers periodically to check their health, completely independent of any data traffic. Active healthchecks are disabled by default and can be enabled for a server pool by binding a health monitor to the pool. If multiple active monitors are configured, the pool member status is UP only when the health check status for all the monitors are UP.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Active monitor path list", 
      "type": "array"
    }, 
    "algorithm": {
      "default": "ROUND_ROBIN", 
      "description": "Load Balancing algorithm chooses a server for each new connection by going through the list of servers in the pool. Currently, following load balancing algorithms are supported with ROUND_ROBIN as the default. ROUND_ROBIN means that a server is selected in a round-robin fashion. The weight would be ignored even if it is configured. WEIGHTED_ROUND_ROBIN means that a server is selected in a weighted round-robin fashion. Default weight of 1 is used if weight is not configured. LEAST_CONNECTION means that a server is selected when it has the least number of connections. The weight would be ignored even if it is configured. Slow start would be enabled by default. WEIGHTED_LEAST_CONNECTION means that a server is selected in a weighted least connection fashion. Default weight of 1 is used if weight is not configured. Slow start would be enabled by default. IP_HASH means that consistent hash is performed on the source IP address of the incoming connection. This ensures that the same client IP address will always reach the same server as long as no server goes down or up. It may be used on the Internet to provide a best-effort stickiness to clients which refuse session cookies.", 
      "enum": [
        "ROUND_ROBIN", 
        "WEIGHTED_ROUND_ROBIN", 
        "LEAST_CONNECTION", 
        "WEIGHTED_LEAST_CONNECTION", 
        "IP_HASH"
      ], 
      "required": false, 
      "title": "Load balancing algorithm", 
      "type": "string"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "member_group": {
      "$ref": "LBPoolMemberGroup, 
      "description": "Load balancer pool support grouping object as dynamic pool members. When member group is defined, members setting should not be specified.", 
      "required": false, 
      "title": "Load balancer member setting with grouping object"
    }, 
    "members": {
      "description": "Server pool consists of one or more pool members. Each pool member is identified, typically, by an IP address and a port.", 
      "items": {
        "$ref": "LBPoolMember
      }, 
      "required": false, 
      "title": "Load balancer pool members", 
      "type": "array"
    }, 
    "min_active_members": {
      "default": 1, 
      "description": "A pool is considered active if there are at least certain minimum number of members.", 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "Minimum number of active pool members to consider pool as active", 
      "type": "integer"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "passive_monitor_path": {
      "description": "Passive healthchecks are disabled by default and can be enabled by attaching a passive health monitor to a server pool. Each time a client connection to a pool member fails, its failed count is incremented. For pools bound to L7 virtual servers, a connection is considered to be failed and failed count is incremented if any TCP connection errors (e.g. TCP RST or failure to send data) or SSL handshake failures occur. For pools bound to L4 virtual servers, if no response is received to a TCP SYN sent to the pool member or if a TCP RST is received in response to a TCP SYN, then the pool member is considered to have failed and the failed count is incremented.", 
      "required": false, 
      "title": "Passive monitor path", 
      "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"
    }, 
    "snat_translation": {
      "$ref": "LBSnatTranslation, 
      "description": "Depending on the topology, Source NAT (SNAT) may be required to ensure traffic from the server destined to the client is received by the load balancer. SNAT can be enabled per pool. If SNAT is not enabled for a pool, then load balancer uses the client IP and port (spoofing) while establishing connections to the servers. This is referred to as no-SNAT or TRANSPARENT mode.  By default Source NAT is enabled as LBSnatAutoMap.", 
      "required": false, 
      "title": "Snat translation configuration"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "tcp_multiplexing_enabled": {
      "default": false, 
      "description": "TCP multiplexing allows the same TCP connection between load balancer and the backend server to be used for sending multiple client requests from different client TCP connections.", 
      "required": false, 
      "title": "TCP multiplexing enable flag", 
      "type": "boolean"
    }, 
    "tcp_multiplexing_number": {
      "default": 6, 
      "description": "The maximum number of TCP connections per pool that are idly kept alive for sending future client requests.", 
      "maximum": 2147483647, 
      "minimum": 0, 
      "required": false, 
      "title": "Maximum number of TCP connections for multiplexing", 
      "type": "integer"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Defining access a Group from a LBVirtualServer and binding to LBMonitorProfile", 
  "type": "object"
}

LBPoolMember (type)

{
  "additionalProperties": false, 
  "description": "Pool member.", 
  "id": "LBPoolMember", 
  "module_id": "PolicyLoadBalancer", 
  "properties": {
    "admin_state": {
      "$ref": "PoolMemberAdminStateType, 
      "default": "ENABLED", 
      "description": "Member admin state.", 
      "required": false, 
      "title": "Member admin state"
    }, 
    "backup_member": {
      "default": false, 
      "description": "Backup servers are typically configured with a sorry page indicating to the user that the application is currently unavailable. While the pool is active (a specified minimum number of pool members are active) BACKUP members are skipped during server selection. When the pool is inactive, incoming connections are sent to only the BACKUP member(s).", 
      "required": false, 
      "title": "Determine whether the pool member is for backup usage", 
      "type": "boolean"
    }, 
    "display_name": {
      "description": "Pool member name.", 
      "required": false, 
      "title": "Pool member name", 
      "type": "string"
    }, 
    "ip_address": {
      "$ref": "IPAddress, 
      "description": "Pool member IP address.", 
      "required": true, 
      "title": "Pool member IP address"
    }, 
    "max_concurrent_connections": {
      "description": "To ensure members are not overloaded, connections to a member can be capped by the load balancer. When a member reaches this limit, it is skipped during server selection. If it is not specified, it means that connections are unlimited.", 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "Maximum concurrent connection number", 
      "type": "integer"
    }, 
    "port": {
      "$ref": "PortElement, 
      "description": "If port is specified, all connections will be sent to this port. Only single port is supported. If unset, the same port the client connected to will be used, it could be overrode by default_pool_member_port setting in virtual server. The port should not specified for port range case.", 
      "required": false, 
      "title": "Pool member port number"
    }, 
    "weight": {
      "default": 1, 
      "description": "Pool member weight is used for WEIGHTED_ROUND_ROBIN balancing algorithm. The weight value would be ignored in other algorithms.", 
      "maximum": 256, 
      "minimum": 1, 
      "required": false, 
      "title": "Pool member weight", 
      "type": "integer"
    }
  }, 
  "title": "Pool member", 
  "type": "object"
}

LBPoolMemberGroup (type)

{
  "additionalProperties": false, 
  "description": "Pool member group.", 
  "id": "LBPoolMemberGroup", 
  "module_id": "PolicyLoadBalancer", 
  "properties": {
    "customized_members": {
      "description": "The list is used to show the customized pool member settings. User can only user pool member action API to update the admin state for a specific IP address.", 
      "items": {
        "$ref": "PoolMemberSetting
      }, 
      "readonly": false, 
      "title": "List of customized pool member settings", 
      "type": "array"
    }, 
    "group_path": {
      "description": "Load balancer pool support Group as dynamic pool members. The IP list of the Group would be used as pool member IP setting.", 
      "required": true, 
      "title": "Grouping object path", 
      "type": "string"
    }, 
    "ip_revision_filter": {
      "default": "IPV4", 
      "description": "Ip revision filter is used to filter IPv4 or IPv6 addresses from the grouping object. If the filter is not specified, both IPv4 and IPv6 addresses would be used as server IPs. The link local and loopback addresses would be always filtered out.", 
      "enum": [
        "IPV4", 
        "IPV6", 
        "IPV4_IPV6"
      ], 
      "required": false, 
      "title": "Filter of ipv4 or ipv6 address of grouping object IP list", 
      "type": "string"
    }, 
    "max_ip_list_size": {
      "description": "The size is used to define the maximum number of grouping object IP address list. These IP addresses would be used as pool members. If the grouping object includes more than certain number of IP addresses, the redundant parts would be ignored and those IP addresses would not be treated as pool members. If the size is not specified, one member is budgeted for this dynamic pool so that the pool has at least one member even if some other dynamic pools grow beyond the capacity of load balancer service. Other members are picked according to available dynamic capacity. The unused members would be set to DISABLED so that the load balancer system itself is not overloaded during runtime.", 
      "maximum": 2147483647, 
      "minimum": 0, 
      "required": false, 
      "title": "Maximum number of grouping object IP address list", 
      "type": "integer"
    }, 
    "port": {
      "description": "If port is specified, all connections will be sent to this port. If unset, the same port the client connected to will be used, it could be overridden by default_pool_member_ports setting in virtual server. The port should not specified for multiple ports case.", 
      "maximum": 65535, 
      "minimum": 1, 
      "required": false, 
      "title": "Pool member port for all IP addresses of the grouping object", 
      "type": "int"
    }
  }, 
  "title": "Pool member group", 
  "type": "object"
}

LBRule (type)

{
  "additionalProperties": false, 
  "description": "Binding of a LBPool and Group to a LBVirtualServer used to route application traffic passing through load balancers. LBRule uses match conditions to match application traffic passing through a LBVirtualServer using HTTP or HTTPS. Can bind multiple LBVirtualServers to a Group. Each LBRule consists of two optional match conditions, each match contidion defines a criterion for application traffic.  If no match conditions are specified, then the LBRule will always match and it is used typically to define default rules. If more than one match condition is specified, then matching strategy determines if all conditions should match or any one condition should match for the LBRule to be considered a match.  A match indicates that the LBVirtualServer should route the request to the Group (parent of LBRule).", 
  "id": "LBRule", 
  "module_id": "PolicyLoadBalancer", 
  "properties": {
    "actions": {
      "description": "A list of actions to be executed at specified phase when load balancer rule matches. The actions are used to manipulate application traffic, such as rewrite URI of HTTP messages, redirect HTTP messages, etc.", 
      "items": {
        "$ref": "LBRuleAction
      }, 
      "maxItems": 60, 
      "required": true, 
      "title": "Actions to be executed", 
      "type": "array"
    }, 
    "display_name": {
      "description": "A display name useful for identifying an LBRule.", 
      "required": false, 
      "title": "Display name for LBRule", 
      "type": "string"
    }, 
    "match_conditions": {
      "description": "A list of match conditions used to match application traffic. Multiple match conditions can be specified in one load balancer rule, each match condition defines a criterion to match application traffic. If no match conditions are specified, then the load balancer rule will always match and it is used typically to define default rules. If more than one match condition is specified, then match strategy determines if all conditions should match or any one condition should match for the load balancer rule to considered a match.", 
      "items": {
        "$ref": "LBRuleCondition
      }, 
      "maxItems": 60, 
      "required": false, 
      "title": "Conditions to match application traffic", 
      "type": "array"
    }, 
    "match_strategy": {
      "default": "ANY", 
      "description": "If more than one match condition is specified, then matching strategy determines if all conditions should match or any one condition should match for the LB Rule to be considered a match. - ALL indicates that both host_match and path_match must match for this LBRule to be considered a match. - ANY indicates that either host_match or patch match may match for this LBRule to be considered a match.", 
      "enum": [
        "ALL", 
        "ANY"
      ], 
      "required": false, 
      "title": "Match strategy for determining match of multiple conditions", 
      "type": "string"
    }, 
    "phase": {
      "default": "HTTP_FORWARDING", 
      "description": "Each load balancer rule is used at a specific phase of load balancer processing. Currently five phases are supported, HTTP_REQUEST_REWRITE, HTTP_FORWARDING, HTTP_RESPONSE_REWRITE, HTTP_ACCESS and TRANSPORT. When an HTTP request message is received by load balancer, all HTTP_REQUEST_REWRITE rules, if present are executed in the order they are applied to virtual server. And then if HTTP_FORWARDING rules present, only first matching rule's action is executed, remaining rules are not checked. HTTP_FORWARDING rules can have only one action. If the request is forwarded to a backend server and the response goes back to load balancer, all HTTP_RESPONSE_REWRITE rules, if present, are executed in the order they are applied to the virtual server. In HTTP_ACCESS phase, user can define action to control access using JWT authentication. In TRANSPORT phase, user can define the condition to match SNI in TLS client hello and define the action to do SSL end-to-end, SSL offloading or SSL passthrough using a specific load balancer server pool.", 
      "enum": [
        "HTTP_REQUEST_REWRITE", 
        "HTTP_FORWARDING", 
        "HTTP_RESPONSE_REWRITE", 
        "HTTP_ACCESS", 
        "TRANSPORT"
      ], 
      "required": false, 
      "title": "Load balancer processing phase", 
      "type": "string"
    }
  }, 
  "title": "Binding of a LBPool and Group to a LBVirtualServer", 
  "type": "object"
}

LBRuleAction (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "description": "Load balancer rule actions are used to manipulate application traffic. Currently load balancer rules can be used at three load balancer processing phases. Each phase has its own supported type of actions. Supported actions in HTTP_REQUST_REWRITE phase are:   LBHttpRequestUriRewriteAction   LBHttpRequestHeaderRewriteAction   LBHttpRequestHeaderDeleteAction   LBVariableAssignmentAction Supported actions in HTTP_FORWARDING phase are:   LBHttpRejectAction   LBHttpRedirectAction   LBSelectPoolAction   LBVariablePersistenceOnAction   LBConnectionDropAction Supported action in HTTP_RESPONSE_REWRITE phase is:   LBHttpResponseHeaderRewriteAction   LBHttpResponseHeaderDeleteAction   LBVariablePersistenceLearnAction Supported action in HTTP_ACCESS phase is:   LBJwtAuthAction   LBConnectionDropAction   LBVariableAssignmentAction Supported action in TRANSPORT phase is:   LBSslModeSelectionAction   LBSelectPoolAction  If the match type of an LBRuleCondition field is specified as REGEX and named capturing groups are used in the specified regular expression. The groups can be used as variables in LBRuleAction fields. For example, define a rule with LBHttpRequestUriCondition as match condition and LBHttpRequestUriRewriteAction as action. Set match_type field of LBHttpRequestUriCondition to REGEX, and set uri field to   \"/news/(?<year>\\d+)/(?<month>\\d+)/(?<article>.*)\". Set uri field of LBHttpRequestUriRewriteAction to:   \"/news/$year-$month/$article\" In uri field of LBHttpRequestUriCondition, the (?<year>\\d+), (?<month>\\d+) and (?<article>.*) are named capturing groups, they define variables named $year, $month and $article respectively. The defined variables are used in LBHttpRequestUriRewriteAction. For a matched HTTP request with URI \"/news/2017/06/xyz.html\", the substring \"2017\" is captured in variable $year, \"06\" is captured in variable $month, and \"xyz.html\" is captured in variable $article. The LBHttpRequestUriRewriteAction will rewrite the URI to:   \"/news/2017-06/xyz.html\" A set of built-in variables can be used in LBRuleAction as well. The name of built-in variables start with underscore, the name of user defined variables is not allowed to start with underscore. Following are some of the built-in variables:   $_scheme: Reference the scheme part of matched HTTP messages, could be \"http\" or \"https\".   $_host: Host of matched HTTP messages, for example \"www.example.com\".   $_server_port: Port part of URI, it is also the port of the server which accepted a request. Default port is 80 for http and 443 for https.   $_uri: The URI path, for example \"/products/sample.html\".   $_request_uri: Full original request URI with arguments, for example,     \"/products/sample.html?a=b&c=d\".   $_args: URI arguments, for instance \"a=b&c=d\"   $_is_args: \"?\" if a request has URI arguments, or an empty string otherwise. For the full list of built-in variables, please reference the NSX-T Administrator's Guide.", 
  "id": "LBRuleAction", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "type"
  }, 
  "properties": {
    "type": {
      "$ref": "LBRuleActionType, 
      "description": "The property identifies the load balancer rule action type.", 
      "required": true, 
      "title": "Type of load balancer rule action"
    }
  }, 
  "title": "Load balancer rule action", 
  "type": "object"
}

LBRuleActionType (type)

{
  "additionalProperties": false, 
  "description": "Types of load balancer rule actions.", 
  "enum": [
    "LBSelectPoolAction", 
    "LBHttpRequestUriRewriteAction", 
    "LBHttpRequestHeaderRewriteAction", 
    "LBHttpRejectAction", 
    "LBHttpRedirectAction", 
    "LBHttpResponseHeaderRewriteAction", 
    "LBHttpRequestHeaderDeleteAction", 
    "LBHttpResponseHeaderDeleteAction", 
    "LBVariableAssignmentAction", 
    "LBVariablePersistenceOnAction", 
    "LBVariablePersistenceLearnAction", 
    "LBJwtAuthAction", 
    "LBSslModeSelectionAction", 
    "LBConnectionDropAction"
  ], 
  "id": "LBRuleActionType", 
  "module_id": "PolicyLoadBalancer", 
  "title": "Types of load balancer rule actions", 
  "type": "string"
}

LBRuleCondition (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "description": "Match conditions are used to match application traffic passing through load balancers. Multiple match conditions can be specified in one load balancer rule, each match condition defines a criterion for application traffic. If inverse field is set to true, the match result of the condition is inverted. If more than one match condition is specified, match strategy determines if all conditions should match or any one condition should match for the load balancer rule to be considered a match. Currently only HTTP messages are supported by load balancer rules. Each load balancer rule is used at a specific phase of load balancer processing. Currently three phases are supported, HTTP_REQUEST_REWRITE, HTTP_FORWARDING and HTTP_RESPONSE_REWRITE. Each phase supports certain types of match conditions, supported match conditions in HTTP_REQUEST_REWRITE phase are: LBHttpRequestMethodCondition LBHttpRequestUriCondition LBHttpRequestUriArgumentsCondition LBHttpRequestVersionCondition LBHttpRequestHeaderCondition LBHttpRequestCookieCondition LBHttpRequestBodyCondition LBTcpHeaderCondition LBIpHeaderCondition LBVariableCondition LBHttpSslCondition Supported match conditions in HTTP_FORWARDING phase are: LBHttpRequestMethodCondition LBHttpRequestUriCondition LBHttpRequestUriArgumentsCondition LBHttpRequestVersionCondition LBHttpRequestHeaderCondition LBHttpRequestCookieCondition LBHttpRequestBodyCondition LBTcpHeaderCondition LBIpHeaderCondition LBVariableCondition LBHttpSslCondition LBSslSniCondition Supported match conditions in HTTP_RESPONSE_REWRITE phase are: LBHttpResponseHeaderCondition LBHttpRequestMethodCondition LBHttpRequestUriCondition LBHttpRequestUriArgumentsCondition LBHttpRequestVersionCondition LBHttpRequestHeaderCondition LBHttpRequestCookieCondition LBTcpHeaderCondition LBIpHeaderCondition LBVariableCondition LBHttpSslCondition Supported match condition in HTTP_ACCESS phase is: LBHttpRequestMethodCondition LBHttpRequestUriCondition LBHttpRequestUriArgumentsCondition LBHttpRequestVersionCondition LBHttpRequestHeaderCondition LBHttpRequestCookieCondition LBHttpRequestBodyCondition LBTcpHeaderCondition LBIpHeaderCondition LBVariableCondition LBHttpSslCondition Supported match condition in TRANSPORT phase is: LBSslSniCondition", 
  "id": "LBRuleCondition", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "type"
  }, 
  "properties": {
    "inverse": {
      "default": false, 
      "required": false, 
      "title": "A flag to indicate whether reverse the match result of this condition", 
      "type": "boolean"
    }, 
    "type": {
      "$ref": "LBRuleConditionType, 
      "required": true, 
      "title": "Type of load balancer rule condition"
    }
  }, 
  "title": "Match condition of load balancer rule", 
  "type": "object"
}

LBRuleConditionType (type)

{
  "additionalProperties": false, 
  "description": "Type of load balancer rule match condition.", 
  "enum": [
    "LBHttpRequestUriCondition", 
    "LBHttpRequestHeaderCondition", 
    "LBHttpRequestMethodCondition", 
    "LBHttpRequestUriArgumentsCondition", 
    "LBHttpRequestVersionCondition", 
    "LBHttpRequestCookieCondition", 
    "LBHttpRequestBodyCondition", 
    "LBHttpResponseHeaderCondition", 
    "LBTcpHeaderCondition", 
    "LBIpHeaderCondition", 
    "LBVariableCondition", 
    "LBHttpSslCondition", 
    "LBSslSniCondition"
  ], 
  "id": "LBRuleConditionType", 
  "module_id": "PolicyLoadBalancer", 
  "title": "Type of load balancer rule match condition", 
  "type": "string"
}

LBSelectPoolAction (type)

{
  "additionalProperties": false, 
  "description": "This action is used to select a pool for matched HTTP request messages. The pool is specified by path. The matched HTTP request messages are forwarded to the specified pool.", 
  "extends": {
    "$ref": "LBRuleAction
  }, 
  "id": "LBSelectPoolAction", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LBSelectPoolAction"
  }, 
  "properties": {
    "pool_id": {
      "description": "Path of load balancer pool.", 
      "required": true, 
      "title": "Path of load balancer pool", 
      "type": "string"
    }, 
    "type": {
      "$ref": "LBRuleActionType, 
      "description": "The property identifies the load balancer rule action type.", 
      "required": true, 
      "title": "Type of load balancer rule action"
    }
  }, 
  "title": "Action to select a pool for HTTP request messages", 
  "type": "object"
}

LBServerAuthType (type)

{
  "additionalProperties": false, 
  "description": "Server authentication could be AUTO_APPLY, REQUIRED or IGNORE, it is used to specify if the server certificate presented to the load balancer during handshake should be actually validated or not. Validation is automatic by default when server_auth_ca_certificate_paths are configured and IGNORED when they are not configured. If validation is REQUIRED, then to be accepted, server certificate must be signed by one of the trusted CAs whose self signed certificates are specified in the same server-side SSL profile binding.", 
  "enum": [
    "REQUIRED", 
    "IGNORE", 
    "AUTO_APPLY"
  ], 
  "id": "LBServerAuthType", 
  "module_id": "PolicyLoadBalancer", 
  "title": "server authentication mode", 
  "type": "string"
}

LBServerSslProfile (type)

{
  "additionalProperties": false, 
  "description": "Server SSL profile.", 
  "extends": {
    "$ref": "LBSslProfile
  }, 
  "id": "LBServerSslProfile", 
  "module_id": "PolicyLoadBalancer", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "cipher_group_label": {
      "$ref": "SslCipherGroup, 
      "description": "It is a label of cipher group which is mostly consumed by GUI.", 
      "required": false, 
      "title": "Label of cipher group"
    }, 
    "ciphers": {
      "description": "Supported SSL cipher list to client side.", 
      "items": {
        "$ref": "SslCipher
      }, 
      "required": false, 
      "title": "Supported SSL cipher list to client side", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "is_fips": {
      "description": "This flag is set to true when all the ciphers and protocols are FIPS compliant. It is set to false when one of the ciphers or protocols are not FIPS compliant.", 
      "readonly": true, 
      "title": "FIPS compliance of ciphers and protocols", 
      "type": "boolean"
    }, 
    "is_secure": {
      "description": "This flag is set to true when all the ciphers and protocols are secure. It is set to false when one of the ciphers or protocols is insecure.", 
      "readonly": true, 
      "title": "Secure/Insecure SSL profile flag", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "protocols": {
      "description": "SSL versions TLS1.1 and TLS1.2 are supported and enabled by default. SSLv2, SSLv3, and TLS1.0 are supported, but disabled by default.", 
      "items": {
        "$ref": "SslProtocol
      }, 
      "required": false, 
      "title": "Supported SSL protocol list to client side", 
      "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"
    }, 
    "session_cache_enabled": {
      "default": true, 
      "description": "SSL session caching allows SSL client and server to reuse previously negotiated security parameters avoiding the expensive public key operation during handshake.", 
      "required": false, 
      "title": "Session cache enable/disable falg", 
      "type": "boolean"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Server SSL profile", 
  "type": "object"
}

LBServerSslProfileBinding (type)

{
  "additionalProperties": false, 
  "description": "Server SSL profile binding.", 
  "id": "LBServerSslProfileBinding", 
  "module_id": "PolicyLoadBalancer", 
  "properties": {
    "certificate_chain_depth": {
      "default": 3, 
      "description": "Authentication depth is used to set the verification depth in the server certificates chain.", 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "The maximum traversal depth of server certificate chain", 
      "type": "integer"
    }, 
    "client_certificate_path": {
      "description": "To support client authentication (load balancer acting as a client authenticating to the backend server), client certificate can be specified in the server-side SSL profile binding", 
      "required": false, 
      "title": "Client certificate path", 
      "type": "string"
    }, 
    "server_auth": {
      "$ref": "LBServerAuthType, 
      "default": "AUTO_APPLY", 
      "description": "Server authentication mode.", 
      "title": "Server authentication mode"
    }, 
    "server_auth_ca_paths": {
      "description": "If server auth type is REQUIRED, server certificate must be signed by one of the trusted Certificate Authorities (CAs), also referred to as root CAs, whose self signed certificates are specified.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "CA path list to verify server certificate", 
      "type": "array"
    }, 
    "server_auth_crl_paths": {
      "description": "A Certificate Revocation List (CRL) can be specified in the server-side SSL profile binding to disallow compromised server certificates.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "CRL path list to verify server certificate", 
      "type": "array"
    }, 
    "ssl_profile_path": {
      "description": "Server SSL profile defines reusable, application-independent server side SSL properties.", 
      "required": false, 
      "title": "Server SSL profile path", 
      "type": "string"
    }
  }, 
  "title": "Server SSL profile binding", 
  "type": "object"
}

LBService (type)

{
  "additionalProperties": false, 
  "description": "Loadbalancer Service.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "LBService", 
  "module_id": "PolicyLoadBalancer", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "access_log_enabled": {
      "deprecated": true, 
      "details": "This is a deprecated property, please use 'access_log_enabled' in\nLBVirtualServer. If both virtual server and load balancer service have\nthe setting, the setting in virtual server layer would override it and\ntake effect.\nIf access log is enabled, all HTTP requests sent to a L7 virtual server\nare logged to the access log file. L4 virtual server connections are\nnot currently logged to the access log.\n", 
      "required": false, 
      "title": "Flag to enable access log", 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "connectivity_path": {
      "description": "LBS could be instantiated (or created) on the Tier-1, etc. For now, only the Tier-1 object is supported.", 
      "required": false, 
      "title": "The connectivity target used to instantiate the LBService", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "enabled": {
      "default": true, 
      "description": "Flag to enable the load balancer service.", 
      "required": false, 
      "title": "Flag to enable the load balancer service", 
      "type": "boolean"
    }, 
    "error_log_level": {
      "$ref": "LbLogLevel, 
      "default": "INFO", 
      "description": "Load balancer engine writes information about encountered issues of different severity levels to the error log. This setting is used to define the severity level of the error log.", 
      "required": false, 
      "title": "Error log level of load balancer service"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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"
    }, 
    "relax_scale_validation": {
      "default": false, 
      "description": "If relax_scale_validation is true, the scale validations for virtual servers/pools/pool members/rules are relaxed for load balancer service. When load balancer service is deployed on edge nodes, the scale of virtual servers/pools/pool members for the load balancer service should not exceed the scale number of the largest load balancer size which could be configured on a certain edge form factor. For example, the largest load balancer size supported on a MEDIUM edge node is MEDIUM. So one SMALL load balancer deployed on MEDIUM edge nodes can support the scale number of MEDIUM load balancer. It is not recommended to enable active monitors if relax_scale_validation is true due to performance consideration. If relax_scale_validation is false, scale numbers should be validated for load balancer service.", 
      "required": false, 
      "title": "Whether scale validation is relaxed", 
      "type": "boolean"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "size": {
      "$ref": "LbServiceSize, 
      "default": "SMALL", 
      "description": "Load balancer service size.", 
      "required": false, 
      "title": "Load balancer service size"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Loadbalancer Service", 
  "type": "object"
}

LBSessionCookieTime (type)

{
  "additionalProperties": false, 
  "description": "Session cookie time.", 
  "extends": {
    "$ref": "LBCookieTime
  }, 
  "id": "LBSessionCookieTime", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LBSessionCookieTime"
  }, 
  "properties": {
    "cookie_max_idle": {
      "description": "Instead of using HTTP Cookie max-age and relying on client to expire the cookie, max idle time and/or max lifetime of the cookie can be used. Max idle time, if configured, specifies the maximum interval the cookie is valid for from the last time it was seen in a request. It is available for insert mode.", 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "Session cookie max idle time in seconds", 
      "type": "integer"
    }, 
    "cookie_max_life": {
      "description": "Max life time, if configured, specifies the maximum interval the cookie is valid for from the first time the cookie was seen in a request. It is available for insert mode.", 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "Session cookie max lifetime in seconds", 
      "type": "integer"
    }, 
    "type": {
      "$ref": "LBCookieTimeType, 
      "required": true
    }
  }, 
  "title": "Session cookie time", 
  "type": "object"
}

LBSnatAutoMap (type)

{
  "additionalProperties": false, 
  "description": "Snat auto map.", 
  "extends": {
    "$ref": "LBSnatTranslation
  }, 
  "id": "LBSnatAutoMap", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LBSnatAutoMap"
  }, 
  "properties": {
    "type": {
      "$ref": "LBSnatTranslationType, 
      "description": "Snat translation type.", 
      "required": true, 
      "title": "Snat translation type"
    }
  }, 
  "title": "Snat auto map", 
  "type": "object"
}

LBSnatDisabled (type)

{
  "additionalProperties": false, 
  "description": "Snat disabled.", 
  "extends": {
    "$ref": "LBSnatTranslation
  }, 
  "id": "LBSnatDisabled", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LBSnatDisabled"
  }, 
  "properties": {
    "type": {
      "$ref": "LBSnatTranslationType, 
      "description": "Snat translation type.", 
      "required": true, 
      "title": "Snat translation type"
    }
  }, 
  "title": "Snat disabled", 
  "type": "object"
}

LBSnatIpElement (type)

{
  "additionalProperties": false, 
  "description": "Snat Ip element.", 
  "id": "LBSnatIpElement", 
  "module_id": "PolicyLoadBalancer", 
  "properties": {
    "ip_address": {
      "$ref": "IPElement, 
      "description": "Ip address or ip range such as 1.1.1.1 or 1.1.1.101-1.1.1.160.", 
      "required": true, 
      "title": "Ip address or ip range"
    }, 
    "prefix_length": {
      "description": "Subnet prefix length should be not specified if there is only one single IP address or IP range.", 
      "required": false, 
      "title": "Subnet prefix length", 
      "type": "integer"
    }
  }, 
  "title": "Snat Ip element", 
  "type": "object"
}

LBSnatIpPool (type)

{
  "additionalProperties": false, 
  "description": "Snat Ip pool.", 
  "extends": {
    "$ref": "LBSnatTranslation
  }, 
  "id": "LBSnatIpPool", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LBSnatIpPool"
  }, 
  "properties": {
    "ip_addresses": {
      "description": "If an IP range is specified, the range may contain no more than 64 IP addresses.", 
      "items": {
        "$ref": "LBSnatIpElement
      }, 
      "maxItems": 64, 
      "required": true, 
      "title": "List of Ip address or ip range", 
      "type": "array"
    }, 
    "type": {
      "$ref": "LBSnatTranslationType, 
      "description": "Snat translation type.", 
      "required": true, 
      "title": "Snat translation type"
    }
  }, 
  "title": "Snat Ip pool", 
  "type": "object"
}

LBSnatTranslation (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "description": "Snat Translation.", 
  "id": "LBSnatTranslation", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "type"
  }, 
  "properties": {
    "type": {
      "$ref": "LBSnatTranslationType, 
      "description": "Snat translation type.", 
      "required": true, 
      "title": "Snat translation type"
    }
  }, 
  "title": "Snat Translation", 
  "type": "object"
}

LBSnatTranslationType (type)

{
  "additionalProperties": false, 
  "description": "Load balancers may need to perform SNAT to ensure reverse traffic from the server can be received and processed by them. There are three modes: LBSnatAutoMap uses the load balancer interface IP and an ephemeral port as the source IP and port of the server side connection. LBSnatIpPool allows user to specify one or more IP addresses along with their subnet masks that should be used for SNAT while connecting to any of the servers in the pool. LBSnatDisabled disables Source NAT. This is referred to as no-SNAT or TRANSPARENT mode.", 
  "enum": [
    "LBSnatAutoMap", 
    "LBSnatIpPool", 
    "LBSnatDisabled"
  ], 
  "id": "LBSnatTranslationType", 
  "module_id": "PolicyLoadBalancer", 
  "title": "Snat translation type", 
  "type": "string"
}

LBSourceIpPersistenceProfile (type)

{
  "additionalProperties": false, 
  "description": "Some applications maintain state and require all relevant connections to be sent to the same server as the application state is not synchronized among servers. Persistence is enabled on a LBVirtualServer by binding a persistence profile to it.", 
  "extends": {
    "$ref": "LBPersistenceProfile
  }, 
  "id": "LBSourceIpPersistenceProfile", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LBSourceIpPersistenceProfile"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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"
    }, 
    "ha_persistence_mirroring_enabled": {
      "default": false, 
      "description": "Persistence entries are not synchronized to the HA peer by default.", 
      "required": false, 
      "title": "Mirroring enabled flag to synchronize persistence entries", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "persistence_shared": {
      "default": false, 
      "description": "Persistence shared setting indicates that all LBVirtualServers that consume this LBPersistenceProfile should share the same persistence mechanism when enabled.  Meaning, persistence entries of a client accessing one virtual server will also affect the same client's connections to a different virtual server. For example, say there are two virtual servers vip-ip1:80 and vip-ip1:8080 bound to the same Group g1 consisting of two servers (s11:80 and s12:80). By default, each virtual server will have its own persistence table or cookie. So, in the earlier example, there will be two tables (vip-ip1:80, p1) and (vip-ip1:8080, p1) or cookies. So, if a client connects to vip1:80 and later connects to vip1:8080, the second connection may be sent to a different server than the first.  When persistence_shared is enabled, then the second connection will always connect to the same server as the original connection. For COOKIE persistence type, the same cookie will be shared by multiple virtual servers. For SOURCE_IP persistence type, the persistence table will be shared across virtual servers. For GENERIC persistence type, the persistence table will be shared across virtual servers which consume the same persistence profile in LBRule actions.", 
      "required": false, 
      "title": "Persistence shared across LBVirtualServers", 
      "type": "boolean"
    }, 
    "purge": {
      "$ref": "SourceIpPersistencePurge, 
      "default": "FULL", 
      "description": "Persistence purge setting.", 
      "required": false, 
      "title": "Persistence purge setting"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The resource_type property identifies persistence profile type.", 
      "enum": [
        "LBSourceIpPersistenceProfile", 
        "LBCookiePersistenceProfile", 
        "LBGenericPersistenceProfile"
      ], 
      "required": true, 
      "title": "Persistence profile type", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "timeout": {
      "default": 300, 
      "description": "When all connections complete (reference count reaches 0), persistence entry timer is started with the expiration time.", 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "Persistence entry expiration time in seconds", 
      "type": "integer"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "LBPersistenceProflie using SourceIP", 
  "type": "object"
}

LBSslModeSelectionAction (type)

{
  "additionalProperties": false, 
  "description": "This action is used to select SSL mode. Three types of SSL mode actions can be specified in Transport phase, ssl passthrough, ssl offloading and ssl end-to-end.", 
  "extends": {
    "$ref": "LBRuleAction
  }, 
  "id": "LBSslModeSelectionAction", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LBSslModeSelectionAction"
  }, 
  "properties": {
    "ssl_mode": {
      "description": "SSL Passthrough: LB establishes a TCP connection with client and another connection with selected backend server. LB won't inspect the stream data between client and backend server, but just pass it through. Backend server exchanges SSL connection with client. SSL Offloading: LB terminiates the connections from client, and establishes SSL connection with it. After receiving the HTTP request, LB connects the selected backend server and talk with it via HTTP without SSL. LB estalishes new connection to selected backend server for each HTTP request, in case server_keep_alive or multiplexing are NOT configured. SSL End-to-End: LB terminiates the connections from client, and establishes SSL connection with it. After receiving the HTTP request, LB connects the selected backend server and talk with it via HTTPS. LB estalishes new SSL connection to selected backend server for each HTTP request, in case server_keep_alive or multiplexing are NOT configured.", 
      "enum": [
        "SSL_PASSTHROUGH", 
        "SSL_END_TO_END", 
        "SSL_OFFLOAD"
      ], 
      "required": true, 
      "title": "Type of SSL mode", 
      "type": "string"
    }, 
    "type": {
      "$ref": "LBRuleActionType, 
      "description": "The property identifies the load balancer rule action type.", 
      "required": true, 
      "title": "Type of load balancer rule action"
    }
  }, 
  "title": "Action to select SSL mode", 
  "type": "object"
}

LBSslProfile (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "description": "Load balancer abstract SSL profile.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "LBSslProfile", 
  "module_id": "PolicyLoadBalancer", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Load balancer abstract SSL profile", 
  "type": "object"
}

LBSslSniCondition (type)

{
  "additionalProperties": false, 
  "description": "This condition is used to match SSL SNI in client hello. This condition is only supported in TRANSPORT phase and HTTP_FORWARDING.", 
  "extends": {
    "$ref": "LBRuleCondition
  }, 
  "id": "LBSslSniCondition", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LBSslSniCondition"
  }, 
  "properties": {
    "case_sensitive": {
      "default": true, 
      "description": "If true, case is significant when comparing SNI value.", 
      "required": false, 
      "title": "A case sensitive flag for SNI comparing", 
      "type": "boolean"
    }, 
    "inverse": {
      "default": false, 
      "required": false, 
      "title": "A flag to indicate whether reverse the match result of this condition", 
      "type": "boolean"
    }, 
    "match_type": {
      "$ref": "LbRuleMatchType, 
      "default": "REGEX", 
      "required": false, 
      "title": "Match type of SNI"
    }, 
    "sni": {
      "description": "The SNI(Server Name indication) in client hello message.", 
      "required": true, 
      "title": "The server name indication", 
      "type": "string"
    }, 
    "type": {
      "$ref": "LBRuleConditionType, 
      "required": true, 
      "title": "Type of load balancer rule condition"
    }
  }, 
  "title": "Condition to match SSL SNI in client hello", 
  "type": "object"
}

LBTcpHeaderCondition (type)

{
  "additionalProperties": false, 
  "description": "This condition is used to match TCP header fields of HTTP messages. Currently, only the TCP source port is supported. Ports can be expressed as a single port number like 80, or a port range like 1024-1030.", 
  "extends": {
    "$ref": "LBRuleCondition
  }, 
  "id": "LBTcpHeaderCondition", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LBTcpHeaderCondition"
  }, 
  "properties": {
    "inverse": {
      "default": false, 
      "required": false, 
      "title": "A flag to indicate whether reverse the match result of this condition", 
      "type": "boolean"
    }, 
    "source_port": {
      "$ref": "PortElement, 
      "required": true, 
      "title": "TCP source port of HTTP message"
    }, 
    "type": {
      "$ref": "LBRuleConditionType, 
      "required": true, 
      "title": "Type of load balancer rule condition"
    }
  }, 
  "title": "Condition to match TCP header fields", 
  "type": "object"
}

LBTcpMonitorProfile (type)

{
  "additionalProperties": false, 
  "description": "Active healthchecks are disabled by default and can be enabled for a server pool by binding a health monitor to the Group through the LBRule object. This represents active health monitoring over TCP. Active healthchecks are initiated periodically, at a configurable interval, to each member of the Group. Only if a healthcheck fails consecutively for a specified number of times (fall_count) to a member will the member status be marked DOWN. Once a member is DOWN, a specified  number of consecutive successful healthchecks (rise_count) will bring  the member back to UP state. After a healthcheck is initiated, if it  does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.", 
  "extends": {
    "$ref": "LBActiveMonitor
  }, 
  "id": "LBTcpMonitorProfile", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LBTcpMonitorProfile"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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"
    }, 
    "fall_count": {
      "default": 3, 
      "description": "Only if a healthcheck fails consecutively for a specified number of times, given with fall_count, to a member will the member status be marked DOWN.", 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "Monitor fall count for active healthchecks", 
      "type": "integer"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "interval": {
      "default": 5, 
      "description": "Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group.", 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "Monitor interval in seconds for active healthchecks", 
      "type": "integer"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "monitor_port": {
      "description": "Typically, monitors perform healthchecks to Group members using the member IP address and pool_port. However, in some cases, customers prefer to run healthchecks against a different port than the pool member port which handles actual application traffic. In such cases, the port to run healthchecks against can be specified in the monitor_port value. For ICMP monitor, monitor_port is not required.", 
      "maximum": 65535, 
      "minimum": 0, 
      "required": false, 
      "title": "Monitor port for active healthchecks", 
      "type": "int"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "receive": {
      "description": "Expected data, if specified, can be anywhere in the response and it has to be a string, regular expressions are not supported.", 
      "required": false, 
      "title": "Expected data received from server", 
      "type": "string"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "$ref": "LBMonitorProfileType, 
      "required": true
    }, 
    "rise_count": {
      "default": 3, 
      "description": "Once a member is DOWN, a specified number of consecutive successful healthchecks specified by rise_count will bring the member back to UP state.", 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "Monitor rise count for active healthchecks", 
      "type": "integer"
    }, 
    "send": {
      "description": "If both send and receive are not specified, then just a TCP connection is established (3-way handshake) to validate server is healthy, no data is sent.", 
      "required": false, 
      "title": "Data to send", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "timeout": {
      "default": 5, 
      "description": "Timeout specified in seconds.  After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.", 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "Monitor timeout in seconds for active healthchecks", 
      "type": "integer"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "LBMonitorProfile for active health checks over TCP", 
  "type": "object"
}

LBUdpMonitorProfile (type)

{
  "additionalProperties": false, 
  "description": "Active healthchecks are disabled by default and can be enabled for a server pool by binding a health monitor to the Group through the LBRule object. This represents active health monitoring over UDP. Active healthchecks are initiated periodically, at a configurable interval, to each member of the Group. Only if a healthcheck fails consecutively for a specified number of times (fall_count) to a member will the member status be marked DOWN. Once a member is DOWN, a specified number of consecutive successful healthchecks (rise_count) will bring the member back to UP state. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.", 
  "extends": {
    "$ref": "LBActiveMonitor
  }, 
  "id": "LBUdpMonitorProfile", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LBUdpMonitorProfile"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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"
    }, 
    "fall_count": {
      "default": 3, 
      "description": "Only if a healthcheck fails consecutively for a specified number of times, given with fall_count, to a member will the member status be marked DOWN.", 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "Monitor fall count for active healthchecks", 
      "type": "integer"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "interval": {
      "default": 5, 
      "description": "Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group.", 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "Monitor interval in seconds for active healthchecks", 
      "type": "integer"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "monitor_port": {
      "description": "Typically, monitors perform healthchecks to Group members using the member IP address and pool_port. However, in some cases, customers prefer to run healthchecks against a different port than the pool member port which handles actual application traffic. In such cases, the port to run healthchecks against can be specified in the monitor_port value. For ICMP monitor, monitor_port is not required.", 
      "maximum": 65535, 
      "minimum": 0, 
      "required": false, 
      "title": "Monitor port for active healthchecks", 
      "type": "int"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "receive": {
      "description": "Expected data, can be anywhere in the response and it has to be a string, regular expressions are not supported. UDP healthcheck is considered failed if there is no server response within the timeout period.", 
      "required": true, 
      "title": "Expected data received from server", 
      "type": "string"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "$ref": "LBMonitorProfileType, 
      "required": true
    }, 
    "rise_count": {
      "default": 3, 
      "description": "Once a member is DOWN, a specified number of consecutive successful healthchecks specified by rise_count will bring the member back to UP state.", 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "Monitor rise count for active healthchecks", 
      "type": "integer"
    }, 
    "send": {
      "description": "The data to be sent to the monitored server.", 
      "required": true, 
      "title": "Data to send", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "timeout": {
      "default": 5, 
      "description": "Timeout specified in seconds.  After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.", 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "Monitor timeout in seconds for active healthchecks", 
      "type": "integer"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "LBMonitorProfile for active health checks over UDP", 
  "type": "object"
}

LBVariableAssignmentAction (type)

{
  "additionalProperties": false, 
  "description": "This action is used to create a new variable and assign value to it. One action can be used to create one variable. To create multiple variables, multiple actions must be defined. The variables can be used by LBVariableCondition, etc.", 
  "extends": {
    "$ref": "LBRuleAction
  }, 
  "id": "LBVariableAssignmentAction", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LBVariableAssignmentAction"
  }, 
  "properties": {
    "type": {
      "$ref": "LBRuleActionType, 
      "description": "The property identifies the load balancer rule action type.", 
      "required": true, 
      "title": "Type of load balancer rule action"
    }, 
    "variable_name": {
      "description": "Name of the variable to be assigned.", 
      "required": true, 
      "title": "Name of the variable to be assigned", 
      "type": "string"
    }, 
    "variable_value": {
      "description": "Value of variable.", 
      "required": true, 
      "title": "Value of variable", 
      "type": "string"
    }
  }, 
  "title": "Action to create variable and assign value to it", 
  "type": "object"
}

LBVariableCondition (type)

{
  "additionalProperties": false, 
  "description": "This condition is used to match variable's name and value at all phases. The variables could be captured from REGEX or assigned by LBVariableAssignmentAction or system embedded variable. Varialbe_name and variable_value should be matched at the same time.", 
  "extends": {
    "$ref": "LBRuleCondition
  }, 
  "id": "LBVariableCondition", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LBVariableCondition"
  }, 
  "properties": {
    "case_sensitive": {
      "default": true, 
      "description": "If true, case is significant when comparing variable value.", 
      "required": false, 
      "title": "A case sensitive flag for variable value comparing", 
      "type": "boolean"
    }, 
    "inverse": {
      "default": false, 
      "required": false, 
      "title": "A flag to indicate whether reverse the match result of this condition", 
      "type": "boolean"
    }, 
    "match_type": {
      "$ref": "LbRuleMatchType, 
      "default": "REGEX", 
      "required": false, 
      "title": "Match type of variable value"
    }, 
    "type": {
      "$ref": "LBRuleConditionType, 
      "required": true, 
      "title": "Type of load balancer rule condition"
    }, 
    "variable_name": {
      "required": true, 
      "title": "Name of the variable to be matched", 
      "type": "string"
    }, 
    "variable_value": {
      "required": true, 
      "title": "Value of variable to be matched", 
      "type": "string"
    }
  }, 
  "title": "Condition to match IP header fields", 
  "type": "object"
}

LBVariablePersistenceLearnAction (type)

{
  "additionalProperties": false, 
  "description": "This action is performed in HTTP response rewrite phase. It is used to learn the value of variable from the HTTP response, and insert an entry into the persistence table if the entry doesn't exist.", 
  "extends": {
    "$ref": "LBRuleAction
  }, 
  "id": "LBVariablePersistenceLearnAction", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LBVariablePersistenceLearnAction"
  }, 
  "properties": {
    "persistence_profile_path": {
      "description": "If the persistence profile path is not specified, a default persistence table is created per virtual server. Currently, only LBGenericPersistenceProfile is supported.", 
      "required": false, 
      "title": "Path to LBPersistenceProfile", 
      "type": "string"
    }, 
    "type": {
      "$ref": "LBRuleActionType, 
      "description": "The property identifies the load balancer rule action type.", 
      "required": true, 
      "title": "Type of load balancer rule action"
    }, 
    "variable_hash_enabled": {
      "default": false, 
      "description": "The property is used to enable a hash operation for variable value when composing the persistence key.", 
      "required": false, 
      "title": "Whether to enable a hash operation for variable value", 
      "type": "boolean"
    }, 
    "variable_name": {
      "description": "The property is the name of variable to be learnt. It is used to identify which variable's value is learnt from HTTP response. The variable can be a built-in variable such as \"_cookie_JSESSIONID\", a customized variable defined in LBVariableAssignmentAction or a captured variable in regular expression such as \"article\". For the full list of built-in variables, please reference the NSX-T Administrator's Guide.", 
      "required": true, 
      "title": "Variable name", 
      "type": "string"
    }
  }, 
  "title": "Action to learn the variable value", 
  "type": "object"
}

LBVariablePersistenceOnAction (type)

{
  "additionalProperties": false, 
  "description": "This action is performed in HTTP forwarding phase. It is used to inspect the variable of HTTP request, and look up the persistence entry with its value and pool uuid as key. If the persistence entry is found, the HTTP request is forwarded to the recorded backend server according to the persistence entry. If the persistence entry is not found, a new entry is created in the table after backend server is selected.", 
  "extends": {
    "$ref": "LBRuleAction
  }, 
  "id": "LBVariablePersistenceOnAction", 
  "module_id": "PolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LBVariablePersistenceOnAction"
  }, 
  "properties": {
    "persistence_profile_path": {
      "description": "If the persistence profile path is not specified, a default persistence table is created per virtual server. Currently, only LBGenericPersistenceProfile is supported.", 
      "required": false, 
      "title": "Path to LBPersistenceProfile", 
      "type": "string"
    }, 
    "type": {
      "$ref": "LBRuleActionType, 
      "description": "The property identifies the load balancer rule action type.", 
      "required": true, 
      "title": "Type of load balancer rule action"
    }, 
    "variable_hash_enabled": {
      "default": false, 
      "description": "The property is used to enable a hash operation for variable value when composing the persistence key.", 
      "required": false, 
      "title": "Whether to enable a hash operation for variable value", 
      "type": "boolean"
    }, 
    "variable_name": {
      "description": "The property is the name of variable to be used. It specifies which variable's value of a HTTP Request will be used in the key of persistence entry. The variable can be a built-in variable such as \"_cookie_JSESSIONID\", a customized variable defined in LBVariableAssignmentAction or a captured variable in regular expression such as \"article\". For the full list of built-in variables, please reference the NSX-T Administrator's Guide.", 
      "required": true, 
      "title": "Variable name", 
      "type": "string"
    }
  }, 
  "title": "Action to persist the variable value", 
  "type": "object"
}

LBVirtualServer (type)

{
  "additionalProperties": false, 
  "description": "All the types of LBVirtualServer extend from this abstract class. This is present for extensibility.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "LBVirtualServer", 
  "module_id": "PolicyLoadBalancer", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "access_list_control": {
      "$ref": "LBAccessListControl, 
      "description": "Specifies the access list control to define how to filter the connections from clients.", 
      "required": false, 
      "title": "IP access list control to filter the connections"
    }, 
    "access_log_enabled": {
      "default": false, 
      "description": "If access log is enabled, all HTTP requests sent to L7 virtual server are logged to the access log file. Both successful returns information responses(1xx), successful responses(2xx), redirection messages(3xx) and unsuccessful requests, backend server returns 4xx or 5xx, are logged to access log, if enabled. All L4 virtual server connections are also logged to the access log if enabled. The non-significant events such as successful requests are not logged if log_significant_event_only is set to true.", 
      "required": false, 
      "title": "Access log enabled setting", 
      "type": "boolean"
    }, 
    "application_profile_path": {
      "description": "The application profile defines the application protocol characteristics. It is used to influence how load balancing is performed. Currently, LBFastTCPProfile, LBFastUDPProfile and LBHttpProfile, etc are supported.", 
      "required": true, 
      "title": "Application profile path", 
      "type": "string"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "client_ssl_profile_binding": {
      "$ref": "LBClientSslProfileBinding, 
      "description": "The setting is used when load balancer acts as an SSL server and terminating the client SSL connection", 
      "required": false, 
      "title": "Virtual server side SSL binding setting"
    }, 
    "default_pool_member_ports": {
      "description": "Default pool member ports when member port is not defined.", 
      "items": {
        "$ref": "PortElement
      }, 
      "maxItems": 14, 
      "required": false, 
      "title": "Default pool member ports when member port is not defined.", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "enabled": {
      "default": true, 
      "description": "Flag to enable the load balancer virtual server.", 
      "required": false, 
      "title": "whether the virtual server is enabled", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ip_address": {
      "$ref": "IPAddress, 
      "description": "Configures the IP address of the LBVirtualServer where it receives all client connections and distributes them among the backend servers.", 
      "required": true, 
      "title": "IP address of the LBVirtualServer"
    }, 
    "lb_persistence_profile_path": {
      "description": "Path to optional object that enables persistence on a virtual server allowing related client connections to be sent to the same backend server. Persistence is disabled by default.", 
      "required": false, 
      "title": "Persistence Profile used by LBVirtualServer", 
      "type": "string"
    }, 
    "lb_service_path": {
      "description": "virtual servers can be associated to LBService(which is similar to physical/virtual load balancer), LB virtual servers, pools and other entities could be defined independently, the LBService identifier list here would be used to maintain the relationship of LBService and other LB entities.", 
      "required": false, 
      "title": "Path to LBService object for LBVirtualServer", 
      "type": "string"
    }, 
    "log_significant_event_only": {
      "default": false, 
      "description": "The property log_significant_event_only can take effect only when access_log_enabled is true. If log_significant_event_only is true, significant events are logged in access log. For L4 virtual server, significant event means unsuccessful(error or dropped) TCP/UDP connections. For L7 virtual server, significant event means unsuccessful connections or HTTP/HTTPS requests which have error response code(e.g. 4xx, 5xx).", 
      "required": false, 
      "title": "Log only significant event in access log", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "max_concurrent_connections": {
      "description": "To ensure one virtual server does not over consume resources, affecting other applications hosted on the same LBS, connections to a virtual server can be capped. If it is not specified, it means that connections are unlimited.", 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "Maximum concurrent connection number", 
      "type": "integer"
    }, 
    "max_new_connection_rate": {
      "description": "To ensure one virtual server does not over consume resources, connections to a member can be rate limited. If it is not specified, it means that connection rate is unlimited.", 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "Maximum new connection rate in connections per second", 
      "type": "integer"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "pool_path": {
      "description": "The server pool(LBPool) contains backend servers. Server pool consists of one or more servers, also referred to as pool members, that are similarly configured and are running the same application.", 
      "required": false, 
      "title": "Default server pool path", 
      "type": "string"
    }, 
    "ports": {
      "description": "Ports contains a list of at least one port or port range such as \"80\", \"1234-1236\". Each port element in the list should be a single port or a single port range.", 
      "items": {
        "$ref": "PortElement
      }, 
      "required": true, 
      "title": "Virtual server port number(s) or port range(s)", 
      "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"
    }, 
    "rules": {
      "description": "Load balancer rules allow customization of load balancing behavior using match/action rules. Currently, load balancer rules are supported for only layer 7 virtual servers with LBHttpProfile.", 
      "items": {
        "$ref": "LBRule
      }, 
      "maxItems": 4000, 
      "required": false, 
      "title": "List of load balancer rules", 
      "type": "array"
    }, 
    "server_ssl_profile_binding": {
      "$ref": "LBServerSslProfileBinding, 
      "description": "The setting is used when load balancer acts as an SSL client and establishing a connection to the backend server.", 
      "required": false, 
      "title": "Pool side SSL binding setting"
    }, 
    "sorry_pool_path": {
      "description": "When load balancer can not select a backend server to serve the request in default pool or pool in rules, the request would be served by sorry server pool.", 
      "required": false, 
      "title": "Sorry server pool path", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Base class for each type of LBVirtualServer", 
  "type": "object"
}

LBXForwardedForType (type)

{
  "additionalProperties": false, 
  "description": "X-forwarded-for type.", 
  "enum": [
    "INSERT", 
    "REPLACE"
  ], 
  "id": "LBXForwardedForType", 
  "module_id": "PolicyLoadBalancer", 
  "title": "X-forwarded-for type", 
  "type": "string"
}

Label (type)

{
  "additionalProperties": false, 
  "description": "Label that will be displayed for a UI element.", 
  "id": "Label", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "properties": {
    "condition": {
      "description": "If the condition is met then the label will be applied. Examples of expression syntax are provided under example_request section of CreateWidgetConfiguration API.", 
      "maxLength": 1024, 
      "title": "Expression for evaluating condition", 
      "type": "string"
    }, 
    "hover": {
      "default": false, 
      "description": "If true, displays the label only on hover", 
      "title": "Show label only on hover", 
      "type": "boolean"
    }, 
    "icons": {
      "description": "Icons to be applied at dashboard for the label", 
      "items": {
        "$ref": "Icon
      }, 
      "minItems": 0, 
      "title": "Icons", 
      "type": "array"
    }, 
    "navigation": {
      "description": "Hyperlink of the specified UI page that provides details.", 
      "maxLength": 1024, 
      "title": "Navigation to a specified UI page", 
      "type": "string"
    }, 
    "text": {
      "description": "Text to be displayed at the label.", 
      "maxLength": 255, 
      "required": true, 
      "title": "Label text", 
      "type": "string"
    }
  }, 
  "title": "Label", 
  "type": "object"
}

LabelValueConfiguration (type)

{
  "additionalProperties": false, 
  "description": "Represents a Label-Value widget configuration", 
  "extends": {
    "$ref": "WidgetConfiguration
  }, 
  "id": "LabelValueConfiguration", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LabelValueConfiguration"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "datasources": {
      "description": "The 'datasources' represent the sources from which data will be fetched. Currently, only NSX-API is supported as a 'default' datasource. An example of specifying 'default' datasource along with the urls to fetch data from is given at 'example_request' section of 'CreateWidgetConfiguration' API.", 
      "items": {
        "$ref": "Datasource
      }, 
      "minItems": 0, 
      "title": "Array of Datasource Instances with their relative urls", 
      "type": "array"
    }, 
    "default_filter_value": {
      "description": "Default filter values to be passed to datasources. This will be used when the report is requested without filter values.", 
      "items": {
        "$ref": "DefaultFilterValue
      }, 
      "title": "Default filter value to be passed to datasources", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "description": "Title of the widget. If display_name is omitted, the widget will be shown without a title.", 
      "maxLength": 255, 
      "title": "Widget Title", 
      "type": "string"
    }, 
    "drilldown_id": {
      "description": "Id of drilldown widget, if any. Id should be a valid id of an existing widget. A widget is considered as drilldown widget when it is associated with any other widget and provides more detailed information about any data item from the parent widget.", 
      "maxLength": 255, 
      "title": "Id of drilldown widget", 
      "type": "string"
    }, 
    "feature_set": {
      "$ref": "FeatureSet, 
      "description": "Features required to view the widget.", 
      "title": "Features required to view the widget"
    }, 
    "filter": {
      "description": "Id of filter widget for subscription, if any. Id should be a valid id of an existing filter widget. Filter widget should be from the same view. Datasource URLs should have placeholder values equal to filter alias to accept the filter value on filter change.", 
      "title": "Id of filter widget for subscription", 
      "type": "string"
    }, 
    "filter_value_required": {
      "default": true, 
      "description": "Flag to indicate that widget will continue to work without filter value. If this flag is set to false then default_filter_value is manadatory.", 
      "title": "Flag to indicate if filter value is necessary", 
      "type": "boolean"
    }, 
    "footer": {
      "$ref": "Footer
    }, 
    "icons": {
      "description": "Icons to be applied at dashboard for widgets and UI elements.", 
      "items": {
        "$ref": "Icon
      }, 
      "title": "Icons", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "is_drilldown": {
      "default": false, 
      "description": "Set to true if this widget should be used as a drilldown.", 
      "title": "Set as a drilldown widget", 
      "type": "boolean"
    }, 
    "layout": {
      "$ref": "Layout, 
      "description": "Layout of properties can be vertical or grid. If layout is not specified a default vertical layout is applied.", 
      "title": "Layout of properties inside widget"
    }, 
    "legend": {
      "$ref": "Legend, 
      "description": "Legend to be displayed. If legend is not needed, do not include it.", 
      "title": "Legend for the widget"
    }, 
    "navigation": {
      "description": "Hyperlink of the specified UI page that provides details.", 
      "maxLength": 1024, 
      "title": "Navigation to a specified UI page", 
      "type": "string"
    }, 
    "properties": {
      "description": "An array of label-value properties.", 
      "items": {
        "$ref": "PropertyItem
      }, 
      "required": true, 
      "title": "Rows", 
      "type": "array"
    }, 
    "resource_type": {
      "description": "Supported visualization types are LabelValueConfiguration, DonutConfiguration, GridConfiguration, StatsConfiguration, MultiWidgetConfiguration, GraphConfiguration, ContainerConfiguration, CustomWidgetConfiguration and DropdownFilterWidgetConfiguration.", 
      "enum": [
        "LabelValueConfiguration", 
        "DonutConfiguration", 
        "MultiWidgetConfiguration", 
        "ContainerConfiguration", 
        "StatsConfiguration", 
        "GridConfiguration", 
        "GraphConfiguration", 
        "CustomWidgetConfiguration", 
        "DropdownFilterWidgetConfiguration"
      ], 
      "maxLength": 255, 
      "readonly": true, 
      "required": true, 
      "title": "Widget visualization type", 
      "type": "string"
    }, 
    "shared": {
      "deprecated": true, 
      "description": "Please use the property 'shared' of View instead of this. The widgets of a shared view are visible to other users.", 
      "title": "Visiblity of widgets to other users", 
      "type": "boolean"
    }, 
    "span": {
      "description": "Represents the horizontal span of the widget / container.", 
      "maximum": 12, 
      "minimum": 1, 
      "title": "Horizontal span", 
      "type": "int"
    }, 
    "sub_type": {
      "description": "A sub-type of LabelValueConfiguration. If sub-type is not specified the parent type is rendered. For VERTICALLY_ALIGNED sub_type, the value is placed below the label.", 
      "enum": [
        "VERTICALLY_ALIGNED"
      ], 
      "title": "Sub-type of the LabelValueConfiguration", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "weight": {
      "deprecated": true, 
      "description": "Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details.", 
      "title": "Weightage or placement of the widget or container", 
      "type": "int"
    }
  }, 
  "title": "Label Value Dashboard Widget Configuration", 
  "type": "object"
}

LacpGroupConfigInfo (type)

{
  "additionalProperties": false, 
  "id": "LacpGroupConfigInfo", 
  "module_id": "InventoryCmInvComm", 
  "properties": {
    "key": {
      "description": "The key represents the identifier for the group that is unique across VC.", 
      "readonly": false, 
      "required": false, 
      "title": "The generated key as the identifier for the group", 
      "type": "string"
    }, 
    "load_balance_algorithm": {
      "description": "Load balance algorithm used in LACP group. The possible values are dictated by the values available in VC. Please refer VMwareDvsLacpLoadBalanceAlgorithm documentation for a full list of values. A few examples are srcDestIp where source and destination IP are considered, srcIp where only source IP is considered.", 
      "readonly": false, 
      "required": false, 
      "title": "Load balance policy", 
      "type": "string"
    }, 
    "mode": {
      "description": "The mode of LACP can be ACTIVE or PASSIVE. If the mode is ACTIVE, LACP is enabled unconditionally. If the mode is PASSIVE, LACP is enabled only if LACP device is detected.", 
      "enum": [
        "ACTIVE", 
        "PASSIVE"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "The mode of Link Aggregation Control Protocol (LACP)", 
      "type": "string"
    }, 
    "name": {
      "description": "The display name of the LACP group.", 
      "readonly": false, 
      "required": false, 
      "title": "The display name", 
      "type": "string"
    }, 
    "uplink_names": {
      "description": "Names for the uplink ports in the group.", 
      "items": {
        "type": "string"
      }, 
      "readonly": false, 
      "required": false, 
      "title": "Uplink names", 
      "type": "array"
    }, 
    "uplink_num": {
      "readonly": false, 
      "required": false, 
      "title": "The number of uplink ports", 
      "type": "integer"
    }, 
    "uplink_port_keys": {
      "description": "Keys for the uplink ports in the group. Each uplink port is assigned a key that is unique across VC.", 
      "items": {
        "type": "string"
      }, 
      "readonly": false, 
      "required": false, 
      "title": "Keys for the uplink ports", 
      "type": "array"
    }
  }, 
  "type": "object"
}

Layout (type)

{
  "additionalProperties": false, 
  "description": "Represents layout of a container or widget", 
  "id": "Layout", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "properties": {
    "properties": {
      "$ref": "LayoutProperties
    }, 
    "type": {
      "default": "HORIZONTAL", 
      "description": "Describes layout of a container or widget. Layout describes how individual widgets are placed inside the container. For example, if HORIZONTAL is chosen widgets are placed side by side inside the container. If VERTICAL is chosen then widgets are placed one below the other. If GRID is chosen then the container or widget display area is divided into a grid of m rows and n columns, as specified in the properties, and the widgets are placed inside the grid.", 
      "enum": [
        "HORIZONTAL", 
        "VERTICAL", 
        "GRID"
      ], 
      "title": "Type of layout of a container or widget", 
      "type": "string"
    }
  }, 
  "title": "Layout of a container or widget", 
  "type": "object"
}

LayoutProperties (type)

{
  "additionalProperties": false, 
  "description": "Properties of the layout of a container or widget", 
  "id": "LayoutProperties", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "properties": {
    "num_columns": {
      "description": "Describes the number of columns of grid layout of a container or widget. This property is applicable for grid layout only.", 
      "title": "Number of columns of grid", 
      "type": "int"
    }, 
    "num_rows": {
      "description": "Describes the number of rows of grid layout of a container or widget. This property is applicable for grid layout only.", 
      "title": "Number of rows of grid", 
      "type": "int"
    }
  }, 
  "title": "Layout properties of a container or widget", 
  "type": "object"
}

LbHttpRequestHeader (type)

{
  "additionalProperties": false, 
  "id": "LbHttpRequestHeader", 
  "module_id": "LoadBalancer", 
  "properties": {
    "header_name": {
      "required": true, 
      "title": "Name of HTTP request header", 
      "type": "string"
    }, 
    "header_value": {
      "required": true, 
      "title": "Value of HTTP request header", 
      "type": "string"
    }
  }, 
  "type": "object"
}

LbLogLevel (type)

{
  "additionalProperties": false, 
  "enum": [
    "DEBUG", 
    "INFO", 
    "WARNING", 
    "ERROR", 
    "CRITICAL", 
    "ALERT", 
    "EMERGENCY"
  ], 
  "id": "LbLogLevel", 
  "module_id": "LoadBalancer", 
  "title": "the log level of load balancer service", 
  "type": "string"
}

LbRuleMatchType (type)

{
  "additionalProperties": false, 
  "description": "LbRuleMatchType is used to determine how a specified string value is used to match a specified LbRuleCondition field. STARTS_WITH: If the LbRuleCondition field starts with specified string, the condition matches. The fields with this match type are specified as strings, not regular expressions. ENDS_WITH: If the LbRuleCondition field ends with specified string, the condition matches. The fields with this match type are specified as strings, not regular expressions. EQUALS: If the LbRuleCondition field is same as the specified string, the condition matches. The fields with this match type are specified as strings, not regular expressions. CONTAINS: If the LbRuleCondition field contains the specified string, the condition matches. The fields with this match type are specified as strings, not regular expressions. REGEX: If the LbRuleCondition field matches specified regular expression, the condition matches. The regular expressions in load balancer rules use the features common to both Java regular expressions and Perl Compatible Regular Expressions (PCREs) with some restrictions. Reference http://www.pcre.org for PCRE and the NSX-T Administrator's Guide for the restrictions. If named capturing groups are used in the regular expression, when a match succeeds, the substrings of the subject string that match named capturing groups are stored (captured) in variables with specific names which can be used in the fields of LbRuleAction which support variables. Named capturing group are defined in the format (?<name>subpattern), such as (?<year>\\d{4}). For example, in the regular expression: \"/news/(?<year>\\d+)/(?<month>\\d+)/(?<article>.*)\", for subject string \"/news/2017/06/xyz.html\", the substring \"2017\" is captured in variable year, \"06\" is captured in variable month, and \"xyz.html\" is captured in variable article. These variables can be used in LbRuleAction fields which support variables in form of $name, such as $year, $month, $article. Please note, when regular expressions are used in JSON(JavaScript Object Notation) string, every backslash character (\\) needs to be escaped by one additional backslash character.", 
  "enum": [
    "STARTS_WITH", 
    "ENDS_WITH", 
    "EQUALS", 
    "CONTAINS", 
    "REGEX"
  ], 
  "id": "LbRuleMatchType", 
  "module_id": "LoadBalancer", 
  "title": "Match type for LbRule conditions", 
  "type": "string"
}

LbServiceSize (type)

{
  "additionalProperties": false, 
  "description": "The size of load balancer service can be, SMALL, MEDIUM, LARGE, XLARGE, or DLB. The first four sizes are realized on Edge node as a centralized load balancer. DLB is realized on each ESXi hypervisor as a distributed load balancer. DLB is supported for k8s cluster IPs managed by vSphere with Kubernetes. DLB is NOT supported for any other workload types.", 
  "enum": [
    "SMALL", 
    "MEDIUM", 
    "LARGE", 
    "XLARGE", 
    "DLB"
  ], 
  "id": "LbServiceSize", 
  "module_id": "LoadBalancer", 
  "title": "the size of load balancer service", 
  "type": "string"
}

LbSslSessionReusedType (type)

{
  "additionalProperties": false, 
  "enum": [
    "IGNORE", 
    "REUSED", 
    "NEW"
  ], 
  "id": "LbSslSessionReusedType", 
  "module_id": "LoadBalancer", 
  "title": "Type of SSL session reused", 
  "type": "string"
}

LdapIdentitySource (type)

{
  "abstract": true, 
  "description": "This is the base type for all identity sources that use LDAP for authentication and group membership.", 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "LdapIdentitySource", 
  "module_id": "LdapIdentitySources", 
  "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: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "alternative_domain_names": {
      "description": "After parsing the \"user@domain\", the domain portion is used to select the LDAP identity source to use. Additional domains listed here will also be directed to this LDAP identity source. In Active Directory these are sometimes referred to as Alternative UPN Suffixes.", 
      "items": {
        "type": "string"
      }, 
      "title": "Additional domains to be directed to this identity source", 
      "type": "array"
    }, 
    "base_dn": {
      "description": "The subtree of the LDAP identity source to search when locating users and groups.", 
      "required": true, 
      "title": "DN of subtree for user and group searches", 
      "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"
    }, 
    "domain_name": {
      "description": "The name of the authentication domain. When users log into NSX using an identity of the form \"user@domain\", NSX uses the domain portion to determine which LDAP identity source to use.", 
      "required": true, 
      "title": "Authentication domain name", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ldap_servers": {
      "description": "The list of LDAP servers that provide LDAP service for this identity source. Currently, only one LDAP server is supported.", 
      "items": {
        "$ref": "IdentitySourceLdapServer
      }, 
      "maxItems": 1, 
      "title": "LDAP servers for this identity source", 
      "type": "array"
    }, 
    "resource_type": {
      "enum": [
        "ActiveDirectoryIdentitySource", 
        "OpenLdapIdentitySource"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "An LDAP identity source", 
  "type": "object"
}

LdapIdentitySourceListResult (type)

{
  "description": "The results of listing LDAP identity sources.", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "LdapIdentitySourceListResult", 
  "module_id": "LdapIdentitySources", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "LdapIdentitySource
      }, 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "List results containing LDAP identity sources", 
  "type": "object"
}

LdapIdentitySourceProbeResults (type)

{
  "description": "Results from probing all LDAP servers in an LDAP identity source configuration.", 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "LdapIdentitySourceProbeResults", 
  "module_id": "LdapIdentitySources", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "results": {
      "description": "Probe results for all probed LDAP servers.", 
      "items": {
        "$ref": "IdentitySourceLdapServerProbeResult
      }, 
      "title": "Probe results", 
      "type": "array"
    }
  }, 
  "title": "Results from probing all LDAP servers", 
  "type": "object"
}

LdapIdentitySourceSearchRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "To search for a user or group in an LDAP identity source, provide a filter_value. The directory will be searched for users and groups that match the search string.  User searches:  For Active Directory sources, the directory will be searched for users whose commonName (CN) property contains the given string and for users whose samAccountName property contains the given string. For OpenLDAP sources, the directory will be searched for users whose commonName (CN) property contains the given string and for users whose uid property contains the given string.  Group searches:  For both Active Directory and OpenLDAP sources, the directory will be searched for groups whose commonName (CN) property contains the the given string.  The LDAP server may impose a limit on the number of returned entries.", 
  "id": "LdapIdentitySourceSearchRequestParameters", 
  "module_id": "LdapIdentitySources", 
  "properties": {
    "filter_value": {
      "description": "A string to use when searching for groups in the LDAP identity source. If not provided, all groups are returned.", 
      "title": "Search filter value", 
      "type": "string"
    }
  }, 
  "title": "Arguments for searching users and groups", 
  "type": "object"
}

LdapIdentitySourceSearchResultItem (type)

{
  "id": "LdapIdentitySourceSearchResultItem", 
  "module_id": "LdapIdentitySources", 
  "properties": {
    "common_name": {
      "description": "The Common Name (CN) of the entry, if available.", 
      "title": "Common Name (CN) of entry", 
      "type": "string"
    }, 
    "dn": {
      "description": "Distinguished name (DN) of the entry.", 
      "title": "DN of the entry", 
      "type": "string"
    }, 
    "principal_name": {
      "description": "For Active Directory (AD) users, this will be the user principal name (UPN), in the format user@domain. For non-AD users, this will be the user's uid property, followed by \"@\" and the domain of the directory. For groups, this will be the group's common name, followed by \"@\" and the domain of the directory.", 
      "title": "The principal name of the user or group, if available", 
      "type": "string"
    }, 
    "type": {
      "description": "Describes the type of the entry", 
      "enum": [
        "USER", 
        "GROUP"
      ], 
      "title": "Type of the entry", 
      "type": "string"
    }
  }, 
  "type": "object"
}

LdapIdentitySourceSearchResultList (type)

{
  "description": "A list of LDA entries returned from a search of an LDAP identity source.", 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "LdapIdentitySourceSearchResultList", 
  "module_id": "LdapIdentitySources", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "results": {
      "items": {
        "$ref": "LdapIdentitySourceSearchResultItem
      }, 
      "type": "array"
    }
  }, 
  "title": "A list of LDAP search results", 
  "type": "object"
}

LdapProbeError (type)

{
  "description": "Detail about one error encountered during a probe.", 
  "id": "LdapProbeError", 
  "module_id": "LdapIdentitySources", 
  "properties": {
    "error_type": {
      "description": "The cause of the error.  BASE_DN_NOT_FOUND: The configured base DN does not exist on the     LDAP server or is not readable. BIND_DN_AND_PASSWORD_REQUIRED: This server is configured to     require a bind DN and password. Please add these to your     LDAP server configuration. BIND_DN_INVALID: The bind DN or username provided is not valid     on the LDAP server. Check that the bind DN is correct.     This error may also indicate that the base DN in your     configuration is incorrect. CERTIFICATE_HOSTNAME_MISMATCH_ERROR: The hostname configured for     the LDAP server does not match the hostname in the server's     certificate subject or alternative subject names. Be sure     that the hostname you configure in NSX Manager matches one     of those names. CERTIFICATE_MISMATCH_ERROR: The certificate presented by the     LDAP server did not match the certificate in the configuration     on the NSX Manager. CONNECTION_REFUSED: The connection was refused when contacting the     LDAP server. Ensure that the LDAP server is running and that     you are using the correct ip/hostname. CONNECTION_TIMEOUT: The connection timed out when contacting     the LDAP server. Check the hostname/ip and any firewalls     between the NSX Manager and the LDAP server. GENERAL_ERROR: An undetermined error occurred. INVALID_CONFIGURED_CERTIFICATE: The certificate configured for     this LDAP server is invalid and could not be decoded. Check     that the PEM-formatted certificate you provided is correct. INVALID_CREDENTIALS: The username and/or password are incorrect. SSL_HANDSHAKE_ERROR: An error occurred while establishing a secure     connection with the LDAP server. Check that the LDAP server's     certificate is correct, and that it is using an SSL/TLS     cipher suite that is compatible with the NSX Manager.     This error can also occur if the hostname you have configured     for the LDAP server does not match any of the hostnames in     the Subject Alternative Name records in the server     certificate. STARTTLS_FAILED: Unable to use StartTLS to upgrade the connection     to use TLS. Ensure that the LDAP server supports TLS and if     not, use LDAP or LDAPS as the protocol. UNKNOWN_HOST: The hostname of the LDAP server could not be     resolved.", 
      "enum": [
        "BASE_DN_NOT_FOUND", 
        "BIND_DN_AND_PASSWORD_REQUIRED", 
        "BIND_DN_INVALID", 
        "CERTIFICATE_HOSTNAME_MISMATCH_ERROR", 
        "CERTIFICATE_MISMATCH_ERROR", 
        "CONNECTION_REFUSED", 
        "CONNECTION_TIMEOUT", 
        "GENERAL_ERROR", 
        "INVALID_CONFIGURED_CERTIFICATE", 
        "INVALID_CREDENTIALS", 
        "SSL_HANDSHAKE_ERROR", 
        "STARTTLS_FAILED", 
        "UNKNOWN_HOST"
      ], 
      "title": "Error type", 
      "type": "string"
    }
  }, 
  "title": "Error detail from probe", 
  "type": "object"
}

Legend (type)

{
  "additionalProperties": false, 
  "description": "Represents legend that describes the entities of the widget.", 
  "id": "Legend", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "properties": {
    "alignment": {
      "default": "VERTICAL", 
      "description": "Describes the alignment of legend. Alignment of a legend denotes how individual items of the legend are aligned in a container. For example, if VERTICAL is chosen then the items of the legend will appear one below the other and if HORIZONTAL is chosen then the items will appear side by side.", 
      "enum": [
        "HORIZONTAL", 
        "VERTICAL"
      ], 
      "title": "Alignment of the legend", 
      "type": "string"
    }, 
    "display_count": {
      "default": true, 
      "description": "If set to true, it will display the counts in legend. If set to false, counts of entities are not displayed in the legend.", 
      "title": "Show count of entities in the legend", 
      "type": "boolean"
    }, 
    "position": {
      "default": "RIGHT", 
      "description": "Describes the relative placement of legend. The legend of a widget can be placed either to the TOP or BOTTOM or LEFT or RIGHT relative to the widget. For example, if RIGHT is chosen then legend is placed to the right of the widget.", 
      "enum": [
        "TOP", 
        "BOTTOM", 
        "LEFT", 
        "RIGHT", 
        "TOP_RIGHT"
      ], 
      "title": "Placement of legend", 
      "type": "string"
    }, 
    "type": {
      "default": "CIRCLE", 
      "description": "Describes the render type for the legend. The legend for an entity describes the entity in the widget. The supported legend type is a circle against which the entity's details such as display_name are shown. The color of the circle denotes the color of the entity shown inside the widget.", 
      "enum": [
        "CIRCLE"
      ], 
      "title": "Type of the legend", 
      "type": "string"
    }, 
    "unit": {
      "description": "Show unit of entities in the legend.", 
      "title": "Show unit of entities in the legend", 
      "type": "string"
    }
  }, 
  "title": "Legend for the widget", 
  "type": "object"
}

ListByNodeIdParameters (type)

{
  "extends": {
    "$ref": "ListWithDataSourceParameters
  }, 
  "id": "ListByNodeIdParameters", 
  "module_id": "AggSvcL2Types", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "source": {
      "$ref": "DataSourceType, 
      "required": false, 
      "title": "The data source, either realtime or cached. If not provided, cached data is returned."
    }, 
    "transport_node_id": {
      "required": false, 
      "title": "TransportNode Id", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ListByOptionalTransportNodeParameters (type)

{
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "ListByOptionalTransportNodeParameters", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "edge_path": {
      "required": false, 
      "title": "Transport node", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ListCertParameter (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "ListCertParameter", 
  "module_id": "CertificateManager", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "details": {
      "default": false, 
      "required": false, 
      "title": "whether to expand the pem data and show all its details", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "type": {
      "description": "Provide this parameter to limit the list of returned certificates to those matching a particular usage. Passing cluster_certificate will return the certificate used for the cluster wide API service.", 
      "enum": [
        "cluster_api_certificate"
      ], 
      "required": false, 
      "title": "Type of certificate to return", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ListRequestParameters (type)

{
  "additionalProperties": {}, 
  "extends": {
    "$ref": "IncludedFieldsParameters
  }, 
  "id": "ListRequestParameters", 
  "module_id": "Common", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ListResult (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "ListResult", 
  "module_id": "Common", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Base class for list results from collections", 
  "type": "object"
}

ListResultQueryParameters (type)

{
  "id": "ListResultQueryParameters", 
  "module_id": "Common", 
  "properties": {
    "fields": {
      "description": "Comma-separated field names to include in query result", 
      "title": "Fields to include in query results", 
      "type": "string"
    }
  }, 
  "title": "Parameters that affect how list results are processed", 
  "type": "object"
}

ListWithDataSourceParameters (type)

{
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "ListWithDataSourceParameters", 
  "module_id": "Types", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "source": {
      "$ref": "DataSourceType, 
      "required": false, 
      "title": "The data source, either realtime or cached. If not provided, cached data is returned."
    }
  }, 
  "type": "object"
}

LiveTraceConfig (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "LiveTraceConfig", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "actions": {
      "$ref": "PolicyLiveTraceActionConfig, 
      "description": "Configuration of actions on the filtered packets.", 
      "required": true, 
      "title": "Livetrace actions"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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"
    }, 
    "filter": {
      "$ref": "LiveTraceFilterData, 
      "description": "Filter for flows of interest.", 
      "required": false, 
      "title": "Packet filter"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "is_transient": {
      "default": true, 
      "description": "This field indicates whether the intent is transient. If it is set to true, intent will be cleaned up after 1 hour of inactivity.", 
      "required": false, 
      "title": "Marker to indicate if the intent is transient", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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"
    }, 
    "src_port_path": {
      "description": "Policy path of logical port to start a livetrace session.", 
      "required": true, 
      "title": "Policy path of logical port", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "timeout": {
      "default": 10, 
      "description": "The duration for observing live traffic on the specified source logical port.", 
      "maximum": 300, 
      "minimum": 5, 
      "required": false, 
      "title": "Timeout in seconds for livetrace session", 
      "type": "integer"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Livetrace configuration", 
  "type": "object"
}

LiveTraceFilterData (type)

{
  "abstract": true, 
  "id": "LiveTraceFilterData", 
  "module_id": "LiveTrace", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "resource_type"
  }, 
  "properties": {
    "resource_type": {
      "default": "FieldsFilterData", 
      "enum": [
        "FieldsFilterData", 
        "PlainFilterData"
      ], 
      "required": true, 
      "title": "Filter type", 
      "type": "string"
    }
  }, 
  "type": "object"
}

LiveTracePacketGranularActionConfig (type)

{
  "additionalProperties": false, 
  "id": "LiveTracePacketGranularActionConfig", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "dest_port_path": {
      "description": "Policy path of logical port for the reverse direction of a livetrace session. It is required only when the trace type is bidirectional. Multiple bi-directional actions in a livetrace session should have the same port specified for the reverse direction.", 
      "required": false, 
      "title": "Policy path of logical port", 
      "type": "string"
    }, 
    "reverse_filter": {
      "$ref": "LiveTraceFilterData, 
      "description": "Filter for flows of interest at the reverse direction. It is required only when the trace type is bidirectional. Multiple bi-directional actions in a livetrace session should have the same filter specified for the reverse direction.", 
      "required": false, 
      "title": "Packet filter"
    }, 
    "sampling": {
      "$ref": "LiveTraceSamplingConfig, 
      "description": "Sampling parameter for the action. Trace action and packet capture action only support first-N sampling.", 
      "required": true, 
      "title": "Sampling parameter for the action"
    }, 
    "trace_type": {
      "enum": [
        "UNI_DIRECTIONAL", 
        "BI_DIRECTIONAL"
      ], 
      "required": true, 
      "title": "Type of trace", 
      "type": "string"
    }
  }, 
  "title": "Configuration of livetrace packet granular action", 
  "type": "object"
}

LiveTraceSamplingConfig (type)

{
  "additionalProperties": false, 
  "id": "LiveTraceSamplingConfig", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "match_number": {
      "description": "First N packets are sampled.", 
      "maximum": 50, 
      "minimum": 1, 
      "required": false, 
      "title": "Parameter for first-N sampling.", 
      "type": "integer"
    }, 
    "sampling_interval": {
      "description": "A packet is sampled for every given time interval in ms.", 
      "maximum": 30000, 
      "minimum": 1, 
      "required": false, 
      "title": "Parameter for interval based sampling", 
      "type": "integer"
    }, 
    "sampling_rate": {
      "description": "1 out of N packets is sampled on average.", 
      "maximum": 65535, 
      "minimum": 1, 
      "required": false, 
      "title": "Parameter for packet number based sampling", 
      "type": "integer"
    }
  }, 
  "title": "Sampling parameter for a livetrace action", 
  "type": "object"
}

LocalEgress (type)

{
  "additionalProperties": false, 
  "description": "Local Egress is used on both server and client sites so that the gateway is used for N-S traffic and overhead on L2VPN tunnel is reduced.", 
  "id": "LocalEgress", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "optimized_ips": {
      "description": "Gateway IP for Local Egress. Local egress is enabled only when this list is not empty.", 
      "items": {
        "$ref": "IPAddress
      }, 
      "maxItems": 1, 
      "minItems": 1, 
      "title": "Gateway IP for Local Egress", 
      "type": "array"
    }
  }, 
  "title": "Local Egress", 
  "type": "object"
}

LocalEgressRoutingEntry (type)

{
  "additionalProperties": false, 
  "id": "LocalEgressRoutingEntry", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "nexthop_address": {
      "description": "Next hop address for proximity routing.", 
      "required": true, 
      "title": "Next hop address", 
      "type": "string"
    }, 
    "prefix_list_paths": {
      "description": "The destination address of traffic matching a prefix-list is forwarded to the nexthop_address. Traffic matching a prefix list with Action DENY will be dropped. Individual prefix-lists specified could have different actions.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 1, 
      "required": true, 
      "title": "Policy path to prefix lists", 
      "type": "array"
    }
  }, 
  "title": "Local egress routing policy", 
  "type": "object"
}

LocaleServices (type)

{
  "additionalProperties": false, 
  "description": "Site specific configuration of Tier0 in multi-site scenario", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "LocaleServices", 
  "module_id": "PolicyConnectivity", 
  "policy_hierarchical_children": [
    "ChildTier1Interface"
  ], 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "bfd_profile_path": {
      "description": "This profile is applied to all static route peers in this locale. BFD profile configured on static route peers takes precedence over global configuration. If this field is empty, a default profile is applied to all peers.", 
      "required": false, 
      "title": "Policy path of BFD profile", 
      "type": "string"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "edge_cluster_path": {
      "description": "Policy path to edge cluster. Auto-assigned on Tier0 if associated enforcement-point has only one edge cluster.", 
      "required": false, 
      "title": "Edge cluster path", 
      "type": "string"
    }, 
    "ha_vip_configs": {
      "description": "This configuration can be defined only for Active-Standby Tier0 gateway to provide redundancy. For mulitple external interfaces, multiple HA VIP configs must be defined and each config will pair exactly two external interfaces. The VIP will move and will always be owned by the Active node. When this property is configured, configuration of dynamic-routing is not allowed.", 
      "items": {
        "$ref": "Tier0HaVipConfig
      }, 
      "title": "Array of HA VIP Config.", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "preferred_edge_paths": {
      "description": "Policy paths to edge nodes. For Tier1 gateway, the field is used to statically assign the ordered list of up to two edge nodes for stateful services. To enable auto allocation of nodes from the specified edge cluster the field must be left unset. The auto allocation of nodes is supported only for the Tier1 gateway.  For Tier0 gateway specified edge is used as a preferred edge node when failover mode is set to PREEMPTIVE, not applicable otherwise.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 2, 
      "required": false, 
      "title": "Edge node path", 
      "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"
    }, 
    "route_redistribution_config": {
      "$ref": "Tier0RouteRedistributionConfig, 
      "description": "Configure all route redistribution properties like enable/disable redistributon, redistribution rule and so on.", 
      "required": false, 
      "title": "Route Redistribution configuration"
    }, 
    "route_redistribution_types": {
      "deprecated": true, 
      "description": "Enable redistribution of different types of routes on Tier-0. This property is only valid for locale-service under Tier-0. This property is deprecated, please use \"route_redistribution_config\" property to configure redistribution rules.", 
      "items": {
        "$ref": "Tier0RouteRedistributionTypes
      }, 
      "required": false, 
      "title": "Enable redistribution of different types of routes on Tier-0", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Locale-services configuration", 
  "type": "object"
}

LocaleServicesListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "LocaleServicesListResult", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "LocaleServices
      }, 
      "required": true, 
      "title": "LocaleServices results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged collection of LocaleServices", 
  "type": "object"
}

LoggingServiceProperties (type)

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

LogicalPortStatistics (type)

{
  "extends": {
    "$ref": "AggregatedDataCounterEx
  }, 
  "id": "LogicalPortStatistics", 
  "module_id": "AggSvcLogicalPort", 
  "properties": {
    "dropped_by_security_packets": {
      "$ref": "PacketsDroppedBySecurity, 
      "readonly": true, 
      "required": false
    }, 
    "last_update_timestamp": {
      "$ref": "EpochMsTimestamp, 
      "description": "Timestamp when the data was last updated; unset if data source has never updated the data.", 
      "readonly": true
    }, 
    "logical_port_id": {
      "readonly": true, 
      "required": true, 
      "title": "The id of the logical port", 
      "type": "string"
    }, 
    "mac_learning": {
      "$ref": "MacLearningCounters, 
      "readonly": true, 
      "required": false
    }, 
    "rx_bytes": {
      "$ref": "DataCounter, 
      "readonly": true, 
      "required": false
    }, 
    "rx_packets": {
      "$ref": "DataCounter, 
      "readonly": true, 
      "required": false
    }, 
    "tx_bytes": {
      "$ref": "DataCounter, 
      "readonly": true, 
      "required": false
    }, 
    "tx_packets": {
      "$ref": "DataCounter, 
      "readonly": true, 
      "required": false
    }
  }, 
  "type": "object"
}

LogicalRouterPortCounters (type)

{
  "id": "LogicalRouterPortCounters", 
  "module_id": "AggSvcLogicalRouterPort", 
  "properties": {
    "blocked_packets": {
      "description": "The total number of packets blocked.", 
      "required": false, 
      "title": "The number of blocked packets", 
      "type": "integer"
    }, 
    "dad_dropped_packets": {
      "description": "Number of duplicate address detected packets dropped.", 
      "required": false, 
      "title": "The number of duplicate address detected packets dropped", 
      "type": "integer"
    }, 
    "destination_unsupported_dropped_packets": {
      "description": "Number of packtes dropped as destination is not supported.", 
      "required": false, 
      "title": "The number of destination unsupported packets dropped", 
      "type": "integer"
    }, 
    "dropped_packets": {
      "description": "The total number of packets dropped.", 
      "required": false, 
      "title": "The number of dropped packets", 
      "type": "integer"
    }, 
    "firewall_dropped_packets": {
      "description": "Number of firewall packets dropped.", 
      "required": false, 
      "title": "The number of firewall packets dropped", 
      "type": "integer"
    }, 
    "frag_needed_dropped_packets": {
      "description": "Number of fragmentation needed packets dropped.", 
      "required": false, 
      "title": "The number of fragmentation needed packets dropped", 
      "type": "integer"
    }, 
    "ipsec_dropped_packets": {
      "description": "Number of IPSec packets dropped", 
      "required": false, 
      "title": "The number of IPSec packets dropped", 
      "type": "integer"
    }, 
    "ipsec_no_sa_dropped_packets": {
      "description": "Number of IPSec no security association packets dropped.", 
      "required": false, 
      "title": "The number of IPSec no security association packets dropped", 
      "type": "integer"
    }, 
    "ipsec_no_vti_dropped_packets": {
      "description": "Number of IPSec packets dropped as no VTI is present.", 
      "required": false, 
      "title": "The number of IPSec no VTI packets dropped", 
      "type": "integer"
    }, 
    "ipsec_pol_block_dropped_packets": {
      "description": "Number of IPSec policy block packets dropped.", 
      "required": false, 
      "title": "The number of IPSec policy block packets dropped", 
      "type": "integer"
    }, 
    "ipsec_pol_err_dropped_packets": {
      "description": "Number of IPSec policy error packets dropped.", 
      "required": false, 
      "title": "The number of IPSec policy error packets dropped", 
      "type": "integer"
    }, 
    "ipv6_dropped_packets": {
      "description": "Number of IPV6 packets dropped.", 
      "required": false, 
      "title": "The number of IPV6 packets dropped", 
      "type": "integer"
    }, 
    "kni_dropped_packets": {
      "description": "Number of DPDK kernal NIC interface packets dropped.", 
      "required": false, 
      "title": "The number of kernal NIC interface packets dropped", 
      "type": "integer"
    }, 
    "l4port_unsupported_dropped_packets": {
      "description": "Number of packets dropped due to unsupported L4 port.", 
      "required": false, 
      "title": "The number of L4 port unsupported packets dropped", 
      "type": "integer"
    }, 
    "malformed_dropped_packets": {
      "description": "Number of packtes dropped as they are malformed.", 
      "required": false, 
      "title": "The number of malformed packets dropped", 
      "type": "integer"
    }, 
    "no_arp_dropped_packets": {
      "description": "Number of no ARP packets dropped.", 
      "required": false, 
      "title": "The number of no ARP packets dropped", 
      "type": "integer"
    }, 
    "no_linked_dropped_packets": {
      "description": "Number of packets dropped as no linked ports are present.", 
      "required": false, 
      "title": "The number of no linked packets dropped", 
      "type": "integer"
    }, 
    "no_mem_dropped_packets": {
      "description": "Number of packets dropped due to insufficient memory.", 
      "required": false, 
      "title": "The number of no memory packets dropped", 
      "type": "integer"
    }, 
    "no_receiver_dropped_packets": {
      "description": "Number of packets dropped due to absence of receiver.", 
      "required": false, 
      "title": "The number of no receiver packets dropped", 
      "type": "integer"
    }, 
    "no_route_dropped_packets": {
      "desrciption": "Number of packets dropped due to absence of routes.", 
      "required": false, 
      "title": "The number of no route packets dropped", 
      "type": "integer"
    }, 
    "non_ip_dropped_packets": {
      "description": "Number of non IP packets dropped.", 
      "required": false, 
      "title": "The number of non IP packets dropped", 
      "type": "integer"
    }, 
    "proto_unsupported_dropped_packets": {
      "description": "Number of packets dropped as protocol is unsupported.", 
      "required": false, 
      "title": "The number of protocol unsupported packets dropped", 
      "type": "integer"
    }, 
    "redirect_dropped_packets": {
      "description": "Number of redirect packets dropped.", 
      "required": false, 
      "title": "The number of redirect packets dropped", 
      "type": "integer"
    }, 
    "rpf_check_dropped_packets": {
      "description": "Number of reverse-path forwarding check packets dropped.", 
      "required": false, 
      "title": "The number of reverse-path forwarding check packets dropped", 
      "type": "integer"
    }, 
    "service_insert_dropped_packets": {
      "description": "Number of service insert packets dropped.", 
      "required": false, 
      "title": "The number of service insert packets dropped", 
      "type": "integer"
    }, 
    "total_bytes": {
      "description": "The total number of bytes transferred.", 
      "required": false, 
      "title": "The total number of bytes", 
      "type": "integer"
    }, 
    "total_packets": {
      "description": "The total number of packets transferred.", 
      "required": false, 
      "title": "The total number of packets", 
      "type": "integer"
    }, 
    "ttl_exceeded_dropped_packets": {
      "description": "Number of time to live exceeded packets dropped.", 
      "required": false, 
      "title": "The number of time to live exceeded packets dropped", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

LogicalRouterPortStatistics (type)

{
  "id": "LogicalRouterPortStatistics", 
  "module_id": "AggSvcLogicalRouterPort", 
  "properties": {
    "logical_router_port_id": {
      "required": true, 
      "title": "The ID of the logical router port", 
      "type": "string"
    }, 
    "per_node_statistics": {
      "additionalProperties": false, 
      "items": {
        "$ref": "LogicalRouterPortStatisticsPerNode
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Per Node Statistics", 
      "type": "array"
    }
  }, 
  "type": "object"
}

LogicalRouterPortStatisticsPerNode (type)

{
  "extends": {
    "$ref": "AggregatedLogicalRouterPortCounters
  }, 
  "id": "LogicalRouterPortStatisticsPerNode", 
  "module_id": "AggSvcLogicalRouterPort", 
  "properties": {
    "last_update_timestamp": {
      "$ref": "EpochMsTimestamp, 
      "readonly": true, 
      "title": "Timestamp when the data was last updated; unset if data source has never updated the data."
    }, 
    "rx": {
      "$ref": "LogicalRouterPortCounters, 
      "readonly": true, 
      "required": false
    }, 
    "transport_node_id": {
      "readonly": true, 
      "required": true, 
      "title": "The ID of the TransportNode", 
      "type": "string"
    }, 
    "tx": {
      "$ref": "LogicalRouterPortCounters, 
      "readonly": true, 
      "required": false
    }
  }, 
  "type": "object"
}

LogicalRouterPortStatisticsSummary (type)

{
  "extends": {
    "$ref": "AggregatedLogicalRouterPortCounters
  }, 
  "id": "LogicalRouterPortStatisticsSummary", 
  "module_id": "AggSvcLogicalRouterPort", 
  "properties": {
    "last_update_timestamp": {
      "$ref": "EpochMsTimestamp, 
      "readonly": true, 
      "title": "Timestamp when the data was last updated; unset if data source has never updated the data."
    }, 
    "logical_router_port_id": {
      "required": true, 
      "title": "The ID of the logical router port", 
      "type": "string"
    }, 
    "rx": {
      "$ref": "LogicalRouterPortCounters, 
      "readonly": true, 
      "required": false
    }, 
    "tx": {
      "$ref": "LogicalRouterPortCounters, 
      "readonly": true, 
      "required": false
    }
  }, 
  "type": "object"
}

LogicalRouterState (type)

{
  "description": "This holds the state of Logical Router. If there are errors in realizing LR outside of MP, it gives details of the components and specific errors.", 
  "extends": {
    "$ref": "EdgeConfigurationState
  }, 
  "id": "LogicalRouterState", 
  "module_id": "LogicalRouter", 
  "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"
    }, 
    "pending_change_list": {
      "description": "Request identifier of the API which modified the entity.", 
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "required": false, 
      "title": "List of pending changes", 
      "type": "array"
    }, 
    "state": {
      "description": "Gives details of state of desired configuration. Additional enums with more details on progress/success/error states are sent for edge node. The success states are NODE_READY and TRANSPORT_NODE_READY, pending states are {VM_DEPLOYMENT_QUEUED, VM_DEPLOYMENT_IN_PROGRESS, REGISTRATION_PENDING} and other values indicate failures. \"in_sync\" state indicates that the desired configuration has been received by the host to which it applies, but is not yet in effect. When the configuration is actually in effect, the state will change to \"success\". Please note, failed state is deprecated.", 
      "enum": [
        "pending", 
        "in_progress", 
        "success", 
        "failed", 
        "partial_success", 
        "orphaned", 
        "unknown", 
        "error", 
        "in_sync", 
        "NOT_AVAILABLE", 
        "VM_DEPLOYMENT_QUEUED", 
        "VM_DEPLOYMENT_IN_PROGRESS", 
        "VM_DEPLOYMENT_FAILED", 
        "VM_POWER_ON_IN_PROGRESS", 
        "VM_POWER_ON_FAILED", 
        "REGISTRATION_PENDING", 
        "NODE_NOT_READY", 
        "NODE_READY", 
        "VM_POWER_OFF_IN_PROGRESS", 
        "VM_POWER_OFF_FAILED", 
        "VM_UNDEPLOY_IN_PROGRESS", 
        "VM_UNDEPLOY_FAILED", 
        "VM_UNDEPLOY_SUCCESSFUL", 
        "EDGE_CONFIG_ERROR", 
        "VM_DEPLOYMENT_RESTARTED", 
        "REGISTRATION_FAILED", 
        "TRANSPORT_NODE_SYNC_PENDING", 
        "TRANSPORT_NODE_CONFIGURATION_MISSING", 
        "EDGE_HARDWARE_NOT_SUPPORTED", 
        "MULTIPLE_OVERLAY_TZS_NOT_SUPPORTED", 
        "TN_OVERLAY_TZ_IN_USE_BY_EDGE_CLUSTER", 
        "TZ_ENDPOINTS_NOT_SPECIFIED", 
        "NO_PNIC_PREPARED_IN_EDGE", 
        "APPLIANCE_INTERNAL_ERROR", 
        "VTEP_DHCP_NOT_SUPPORTED", 
        "UNSUPPORTED_HOST_SWITCH_PROFILE", 
        "UPLINK_HOST_SWITCH_PROFILE_NOT_SPECIFIED", 
        "HOSTSWITCH_PROFILE_NOT_FOUND", 
        "LLDP_SEND_ENABLED_NOT_SUPPORTED", 
        "UNSUPPORTED_NAMED_TEAMING_POLICY", 
        "LBSRCID_NOT_SUPPORTED_FOR_EDGE_VM", 
        "LACP_NOT_SUPPORTED_FOR_EDGE_VM", 
        "STANDBY_UPLINKS_NOT_SUPPORTED_FOR_EDGE_VM", 
        "MULTIPLE_ACTIVE_UPLINKS_NOT_SUPPORTED_FOR_EDGE", 
        "UNSUPPORTED_LACP_LB_ALGO_FOR_NODE", 
        "EDGE_NODE_VERSION_NOT_SUPPORTED", 
        "NO_PNIC_SPECIFIED_IN_TN", 
        "INVALID_PNIC_DEVICE_NAME", 
        "TRANSPORT_NODE_READY", 
        "VM_NETWORK_EDIT_PENDING", 
        "UNSUPPORTED_DEFAULT_TEAMING_POLICY", 
        "MPA_DISCONNECTED", 
        "VM_RENAME_PENDING", 
        "VM_CONFIG_EDIT_PENDING", 
        "VM_NETWORK_EDIT_FAILED", 
        "VM_RENAME_FAILED", 
        "VM_CONFIG_EDIT_FAILED", 
        "VM_CONFIG_DISCREPANCY", 
        "VM_NODE_REFRESH_FAILED", 
        "VM_PLACEMENT_REFRESH_FAILED", 
        "REGISTRATION_TIMEDOUT", 
        "REPLACE_FAILED", 
        "UPLINK_FROM_TEAMING_POLICY_NOT_MAPPED", 
        "LOGICAL_SWITCH_NAMED_TEAMING_HAS_NO_PNIC_BACKING", 
        "DELETE_VM_IN_REDEPLOY_FAILED", 
        "DEPLOY_VM_IN_REDEPLOY_FAILED", 
        "INSUFFICIENT_RESOURCES_IN_EDGE_NODE_FOR_SERVICE"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Overall state of desired configuration", 
      "type": "string"
    }
  }, 
  "title": "Realization State of Logical Router.", 
  "type": "object"
}

LogicalRouterStatus (type)

{
  "additionalProperties": false, 
  "id": "LogicalRouterStatus", 
  "module_id": "AggSvcLogicalRouter", 
  "properties": {
    "last_update_timestamp": {
      "$ref": "EpochMsTimestamp, 
      "readonly": true, 
      "title": "Timestamp when the data was last updated; unset if data source has never updated the data."
    }, 
    "locale_operation_mode": {
      "description": "Egress mode for the logical router at given mode", 
      "enum": [
        "PRIMARY_LOCATION", 
        "SECONDARY_LOCATION"
      ], 
      "readonly": true, 
      "title": "Location mode for logical router", 
      "type": "string"
    }, 
    "logical_router_id": {
      "required": true, 
      "title": "The id of the logical router", 
      "type": "string"
    }, 
    "per_node_status": {
      "items": {
        "$ref": "LogicalRouterStatusPerNode
      }, 
      "readonly": true, 
      "title": "Per Node Status", 
      "type": "array"
    }
  }, 
  "type": "object"
}

LogicalRouterStatusPerNode (type)

{
  "id": "LogicalRouterStatusPerNode", 
  "module_id": "AggSvcLogicalRouter", 
  "properties": {
    "high_availability_status": {
      "enum": [
        "ACTIVE", 
        "STANDBY", 
        "DOWN", 
        "SYNC", 
        "UNKNOWN", 
        "ADMIN_DOWN"
      ], 
      "required": true, 
      "title": "A service router's HA status on an edge node", 
      "type": "string"
    }, 
    "service_router_id": {
      "required": false, 
      "title": "id of the service router where the router status is retrieved.", 
      "type": "string"
    }, 
    "transport_node_id": {
      "required": true, 
      "title": "id of the transport node where the router status is retrieved.", 
      "type": "string"
    }
  }, 
  "type": "object"
}

LogicalSwitchStatistics (type)

{
  "extends": {
    "$ref": "AggregatedDataCounterEx
  }, 
  "id": "LogicalSwitchStatistics", 
  "module_id": "AggSvcLogicalSwitch", 
  "properties": {
    "dropped_by_security_packets": {
      "$ref": "PacketsDroppedBySecurity, 
      "readonly": true, 
      "required": false
    }, 
    "last_update_timestamp": {
      "$ref": "EpochMsTimestamp, 
      "description": "Timestamp when the data was last updated; unset if data source has never updated the data.", 
      "readonly": true
    }, 
    "logical_switch_id": {
      "readonly": true, 
      "required": true, 
      "title": "The id of the logical Switch", 
      "type": "string"
    }, 
    "mac_learning": {
      "$ref": "MacLearningCounters, 
      "readonly": true, 
      "required": false
    }, 
    "rx_bytes": {
      "$ref": "DataCounter, 
      "readonly": true, 
      "required": false
    }, 
    "rx_packets": {
      "$ref": "DataCounter, 
      "readonly": true, 
      "required": false
    }, 
    "tx_bytes": {
      "$ref": "DataCounter, 
      "readonly": true, 
      "required": false
    }, 
    "tx_packets": {
      "$ref": "DataCounter, 
      "readonly": true, 
      "required": false
    }
  }, 
  "type": "object"
}

MACAddress (type)

{
  "description": "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.", 
  "format": "mac-address", 
  "id": "MACAddress", 
  "module_id": "Common", 
  "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. Avoid creating groups with multiple MACAddressExpression. In future releases, group will be restricted to contain a single MACAddressExpression. To group MAC addresses, use nested groups instead of multiple MACAddressExpression.", 
  "extends": {
    "$ref": "Expression
  }, 
  "id": "MACAddressExpression", 
  "module_id": "Policy", 
  "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: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mac_addresses": {
      "description": "This array can consist of one or more MAC addresses.", 
      "items": {
        "$ref": "MACAddress
      }, 
      "maxItems": 4000, 
      "minItems": 1, 
      "required": true, 
      "title": "Array of MAC addresses", 
      "type": "array"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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", 
        "ExternalIDExpression", 
        "PathExpression", 
        "IdentityGroupExpression"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "MAC address expression node", 
  "type": "object"
}

MACAddressList (type)

{
  "additionalProperties": false, 
  "description": "List of MAC Addresses.", 
  "id": "MACAddressList", 
  "module_id": "Policy", 
  "properties": {
    "mac_addresses": {
      "description": "The array contains MAC addresses.", 
      "items": {
        "$ref": "MACAddress
      }, 
      "maxItems": 4000, 
      "minItems": 1, 
      "required": true, 
      "title": "Array of MAC addresses", 
      "type": "array"
    }
  }, 
  "title": "MAC Address members.", 
  "type": "object"
}

MacAddressCsvListResult (type)

{
  "extends": {
    "$ref": "CsvListResult
  }, 
  "id": "MacAddressCsvListResult", 
  "module_id": "AggSvcLogicalSwitch", 
  "properties": {
    "file_name": {
      "description": "File name set by HTTP server if API  returns CSV result as a file.", 
      "required": false, 
      "title": "File name", 
      "type": "string"
    }, 
    "last_update_timestamp": {
      "$ref": "EpochMsTimestamp, 
      "description": "Timestamp when the data was last updated; unset if data source has never updated the data.", 
      "readonly": true
    }, 
    "results": {
      "items": {
        "$ref": "MacTableCsvRecord
      }, 
      "required": false, 
      "type": "array"
    }
  }, 
  "type": "object"
}

MacAddressType (type)

{
  "enum": [
    "STATIC", 
    "LEARNED"
  ], 
  "id": "MacAddressType", 
  "module_id": "AggSvcLogicalPort", 
  "title": "The type of the MAC address", 
  "type": "string"
}

MacDiscoveryProfile (type)

{
  "additionalProperties": false, 
  "description": "Mac Discovery Profile", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "MacDiscoveryProfile", 
  "module_id": "PolicyMacDiscovery", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mac_change_enabled": {
      "default": false, 
      "description": "Allowing source MAC address change", 
      "required": false, 
      "title": "Is rule enabled or not", 
      "type": "boolean"
    }, 
    "mac_learning_aging_time": {
      "default": 600, 
      "description": "Indicates how long learned MAC address remain.", 
      "readonly": true, 
      "required": false, 
      "title": "Aging time in seconds for learned MAC address", 
      "type": "int"
    }, 
    "mac_learning_enabled": {
      "description": "Allowing source MAC address learning", 
      "required": true, 
      "title": "Is MAC learning enabled or not", 
      "type": "boolean"
    }, 
    "mac_limit": {
      "default": 4096, 
      "description": "The maximum number of MAC addresses that can be learned on this port", 
      "maximum": 4096, 
      "minimum": 0, 
      "required": false, 
      "title": "Maximum number of arp bindings", 
      "type": "int"
    }, 
    "mac_limit_policy": {
      "default": "ALLOW", 
      "description": "The policy after MAC Limit is exceeded", 
      "enum": [
        "ALLOW", 
        "DROP"
      ], 
      "title": "Mac Limit Policy", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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"
    }, 
    "remote_overlay_mac_limit": {
      "default": 2048, 
      "description": "This property specifies the limit on the maximum number of MACs learned for a remote virtual machine's MAC to VTEP binding per overlay logical switch.", 
      "maximum": 8192, 
      "minimum": 2048, 
      "title": "The maximum number of MAC addresses learned on an overlay Logical Switch", 
      "type": "int"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }, 
    "unknown_unicast_flooding_enabled": {
      "default": true, 
      "description": "Allowing flooding for unlearned MAC for ingress traffic", 
      "required": false, 
      "title": "Is unknown unicast flooding rule enabled or not", 
      "type": "boolean"
    }
  }, 
  "search_dsl_name": [
    "mac discovery segment profile"
  ], 
  "title": "Mac Discovery Profile", 
  "type": "object"
}

MacDiscoveryProfileListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "MacDiscoveryProfileListRequestParameters", 
  "module_id": "PolicyMacDiscovery", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Mac Discovery Profile request parameters", 
  "type": "object"
}

MacDiscoveryProfileListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "MacDiscoveryProfileListResult", 
  "module_id": "PolicyMacDiscovery", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "MacDiscoveryProfile
      }, 
      "required": true, 
      "title": "Mac Discovery profile list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged collection of Mac Discovery Profiles", 
  "type": "object"
}

MacLearningCounters (type)

{
  "id": "MacLearningCounters", 
  "module_id": "AggSvcL2Types", 
  "properties": {
    "mac_not_learned_packets_allowed": {
      "description": "The number of packets with unknown source MAC address that are dispatched without learning the source MAC address. Applicable only when the MAC limit is reached and MAC Limit policy is MAC_LEARNING_LIMIT_POLICY_ALLOW.", 
      "required": false, 
      "title": "Number of dispatched packets with unknown source MAC address.", 
      "type": "integer"
    }, 
    "mac_not_learned_packets_dropped": {
      "description": "The number of packets with unknown source MAC address that are dropped without learning the source MAC address. Applicable only when the MAC limit is reached and MAC Limit policy is MAC_LEARNING_LIMIT_POLICY_DROP.", 
      "required": false, 
      "title": "Number of dropped packets with unknown source MAC address.", 
      "type": "integer"
    }, 
    "macs_learned": {
      "required": false, 
      "title": "Number of MACs learned", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

MacTableCsvRecord (type)

{
  "extends": {
    "$ref": "CsvRecord
  }, 
  "id": "MacTableCsvRecord", 
  "module_id": "AggSvcLogicalSwitch", 
  "properties": {
    "mac_address": {
      "required": true, 
      "title": "The MAC address", 
      "type": "string"
    }, 
    "rtep_group_id": {
      "description": "RTEP group id is applicable when the logical switch is stretched across multiple sites. When rtep_group_id is set, mac_address represents remote mac_address.", 
      "title": "Remote tunnel endpoint(RTEP) group id", 
      "type": "integer"
    }, 
    "vtep_group_id": {
      "description": "VTEP group id is applicable when the logical switch is stretched across multiple sites. When vtep_group_id is set, mac_address represents remote mac_address.", 
      "title": "Virtual tunnel endpoint(VTEP) group id", 
      "type": "integer"
    }, 
    "vtep_ip": {
      "$ref": "IPAddress, 
      "required": false, 
      "title": "The virtual tunnel endpoint IP address"
    }, 
    "vtep_mac_address": {
      "required": false, 
      "title": "The virtual tunnel endpoint MAC address", 
      "type": "string"
    }
  }, 
  "type": "object"
}

MacTableEntry (type)

{
  "id": "MacTableEntry", 
  "module_id": "AggSvcLogicalSwitch", 
  "properties": {
    "mac_address": {
      "required": true, 
      "title": "The MAC address", 
      "type": "string"
    }, 
    "rtep_group_id": {
      "description": "RTEP group id is applicable when the logical switch is stretched across multiple sites. When rtep_group_id is set, mac_address represents remote mac_address.", 
      "title": "Remote tunnel endpoint(RTEP) group id", 
      "type": "integer"
    }, 
    "vtep_group_id": {
      "description": "VTEP group id is applicable when the logical switch is stretched across multiple sites. When vtep_group_id is set, mac_address represents remote mac_address.", 
      "title": "Virtual tunnel endpoint(VTEP) group id", 
      "type": "integer"
    }, 
    "vtep_ip": {
      "$ref": "IPAddress, 
      "required": false, 
      "title": "The virtual tunnel endpoint IP address"
    }, 
    "vtep_mac_address": {
      "required": false, 
      "title": "The virtual tunnel endpoint MAC address", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ManagedResource (type)

{
  "abstract": true, 
  "extends": {
    "$ref": "RevisionedResource
  }, 
  "id": "ManagedResource", 
  "module_id": "Common", 
  "polymorphic-type-descriptor": {
    "mode": "force", 
    "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: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Base type for resources that are managed by API clients", 
  "type": "object"
}

ManagementConfig (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "RevisionedResource
  }, 
  "id": "ManagementConfig", 
  "module_id": "ConfigManagement", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "publish_fqdns": {
      "required": true, 
      "title": "True if Management nodes publish their fqdns(instead of default IP addresses) across NSX for its reachability.", 
      "type": "boolean"
    }
  }, 
  "type": "object"
}

MandatoryAccessControlProperties (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "MandatoryAccessControlProperties", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "enabled": {
      "description": "Enabled can be True/False", 
      "type": "boolean"
    }, 
    "status": {
      "description": "current status of Mandatory Access Control", 
      "enum": [
        "ENABLED", 
        "DISABLED", 
        "ENABLED_PENDING_REBOOT"
      ], 
      "readonly": true, 
      "type": "string"
    }
  }, 
  "title": "Information about mandatory access control", 
  "type": "object"
}

MetadataProxyConfig (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "MetadataProxyConfig", 
  "module_id": "PolicyMetadataProxy", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "crypto_protocols": {
      "description": "The cryptographic protocols listed here are supported by the metadata proxy. TLSv1.1 and TLSv1.2 are supported by default", 
      "items": {
        "$ref": "MetadataProxyCryptoProtocols
      }, 
      "title": "Metadata proxy supported cryptographic protocols", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "edge_cluster_path": {
      "description": "Edge clusters configured on MP are auto-discovered by Policy and create corresponding read-only intent objects.", 
      "required": true, 
      "title": "Poilcy path to Edge Cluster", 
      "type": "string"
    }, 
    "enable_standby_relocation": {
      "default": false, 
      "description": "Only auto-placed metadata proxies are considered for relocation. Must be FALSE, when the preferred_edge_paths property is configured.", 
      "title": "Flag  to enable standby relocation", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "preferred_edge_paths": {
      "description": "Edge nodes should be members of edge cluster configured in edge_cluster_path.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 2, 
      "title": "Preferred Edge Paths", 
      "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"
    }, 
    "secret": {
      "description": "Secret word or phrase to access metadata server.", 
      "required": true, 
      "title": "Secret", 
      "type": "string"
    }, 
    "server_address": {
      "description": "This field is a URL. Example formats - http://1.2.3.4:3888/path, http://text-md-proxy:5001/. Port number should be between 3000-9000.", 
      "required": true, 
      "title": "Server Address", 
      "type": "string"
    }, 
    "server_certificates": {
      "description": "Valid certificates should be configured. The validity of certificates is not checked. Certificates are managed through /infra/certificates API on Policy.", 
      "items": {
        "type": "string"
      }, 
      "title": "Policy paths to Certificate Authority (CA) certificates", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Metadata Proxy Configuration", 
  "type": "object"
}

MetadataProxyCryptoProtocols (type)

{
  "additionalProperties": false, 
  "default": "TLS_V1_2", 
  "enum": [
    "TLS_V1", 
    "TLS_V1_1", 
    "TLS_V1_2"
  ], 
  "id": "MetadataProxyCryptoProtocols", 
  "module_id": "PolicyMetadataProxy", 
  "title": "Metadata proxy supported cryptographic protocol", 
  "type": "string"
}

MirrorStackStatusListResult (type)

{
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "MirrorStackStatusListResult", 
  "module_id": "PortMirroring", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "overall_status": {
      "$ref": "MirrorStackStatusType, 
      "description": "SUCCESS if all the TN's stack status are SUCCESS, FAILED if some of the TN's stack status are FAILED.", 
      "required": true, 
      "title": "Overall mirror stack status for all the TNs"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "List all TN nodes which spaned in remote L3 mirror session mirror stack health status detailed info, including mirror stack status, vmknic status, TN node ID, TN node name and last updated status timestamp.", 
      "items": {
        "$ref": "TnNodeStackSpanStatus
      }, 
      "required": true, 
      "title": "All TN nodes in remote L3 mirror session mirror stack health status", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

MirrorStackStatusType (type)

{
  "additionalProperties": false, 
  "description": "MirrorStackStatusType indicates the health result after user configured mirror stack on L3PortMirrorSession. When configure mirror stack on L3PortMirrorSession, it has two preconditions, ESXi has been configured mirror stack and vmknic has been bounded to the stack. SUCCESS means the host has mirror stack and vmknic has been bounded to the stack, FAILED means either there is no mirror stack or the vmknic not bounded to it.", 
  "enum": [
    "UNKNOWN", 
    "SUCCESS", 
    "FAILED"
  ], 
  "id": "MirrorStackStatusType", 
  "module_id": "PortMirroring", 
  "title": "Mirror stack status type", 
  "type": "string"
}

MonitoringProfileBindingMap (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "MonitoringProfileBindingMap", 
  "module_id": "PolicyMonitoringProfileBinding", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Base Monitoring Profile Binding Map", 
  "type": "object"
}

MultiWidgetConfiguration (type)

{
  "additionalProperties": false, 
  "description": "Combines two or more widgetconfigurations into a multi-widget", 
  "extends": {
    "$ref": "WidgetConfiguration
  }, 
  "id": "MultiWidgetConfiguration", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "polymorphic-type-descriptor": {
    "type-identifier": "MultiWidgetConfiguration"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "datasources": {
      "description": "The 'datasources' represent the sources from which data will be fetched. Currently, only NSX-API is supported as a 'default' datasource. An example of specifying 'default' datasource along with the urls to fetch data from is given at 'example_request' section of 'CreateWidgetConfiguration' API.", 
      "items": {
        "$ref": "Datasource
      }, 
      "minItems": 0, 
      "title": "Array of Datasource Instances with their relative urls", 
      "type": "array"
    }, 
    "default_filter_value": {
      "description": "Default filter values to be passed to datasources. This will be used when the report is requested without filter values.", 
      "items": {
        "$ref": "DefaultFilterValue
      }, 
      "title": "Default filter value to be passed to datasources", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "description": "Title of the widget. If display_name is omitted, the widget will be shown without a title.", 
      "maxLength": 255, 
      "title": "Widget Title", 
      "type": "string"
    }, 
    "drilldown_id": {
      "description": "Id of drilldown widget, if any. Id should be a valid id of an existing widget. A widget is considered as drilldown widget when it is associated with any other widget and provides more detailed information about any data item from the parent widget.", 
      "maxLength": 255, 
      "title": "Id of drilldown widget", 
      "type": "string"
    }, 
    "feature_set": {
      "$ref": "FeatureSet, 
      "description": "Features required to view the widget.", 
      "title": "Features required to view the widget"
    }, 
    "filter": {
      "description": "Id of filter widget for subscription, if any. Id should be a valid id of an existing filter widget. Filter widget should be from the same view. Datasource URLs should have placeholder values equal to filter alias to accept the filter value on filter change.", 
      "title": "Id of filter widget for subscription", 
      "type": "string"
    }, 
    "filter_value_required": {
      "default": true, 
      "description": "Flag to indicate that widget will continue to work without filter value. If this flag is set to false then default_filter_value is manadatory.", 
      "title": "Flag to indicate if filter value is necessary", 
      "type": "boolean"
    }, 
    "footer": {
      "$ref": "Footer
    }, 
    "icons": {
      "description": "Icons to be applied at dashboard for widgets and UI elements.", 
      "items": {
        "$ref": "Icon
      }, 
      "title": "Icons", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "is_drilldown": {
      "default": false, 
      "description": "Set to true if this widget should be used as a drilldown.", 
      "title": "Set as a drilldown widget", 
      "type": "boolean"
    }, 
    "legend": {
      "$ref": "Legend, 
      "description": "Legend to be displayed. If legend is not needed, do not include it.", 
      "title": "Legend for the widget"
    }, 
    "navigation": {
      "description": "Hyperlink of the specified UI page that provides details.", 
      "maxLength": 1024, 
      "title": "Navigation to a specified UI page", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "Supported visualization types are LabelValueConfiguration, DonutConfiguration, GridConfiguration, StatsConfiguration, MultiWidgetConfiguration, GraphConfiguration, ContainerConfiguration, CustomWidgetConfiguration and DropdownFilterWidgetConfiguration.", 
      "enum": [
        "LabelValueConfiguration", 
        "DonutConfiguration", 
        "MultiWidgetConfiguration", 
        "ContainerConfiguration", 
        "StatsConfiguration", 
        "GridConfiguration", 
        "GraphConfiguration", 
        "CustomWidgetConfiguration", 
        "DropdownFilterWidgetConfiguration"
      ], 
      "maxLength": 255, 
      "readonly": true, 
      "required": true, 
      "title": "Widget visualization type", 
      "type": "string"
    }, 
    "shared": {
      "deprecated": true, 
      "description": "Please use the property 'shared' of View instead of this. The widgets of a shared view are visible to other users.", 
      "title": "Visiblity of widgets to other users", 
      "type": "boolean"
    }, 
    "span": {
      "description": "Represents the horizontal span of the widget / container.", 
      "maximum": 12, 
      "minimum": 1, 
      "title": "Horizontal span", 
      "type": "int"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "weight": {
      "deprecated": true, 
      "description": "Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details.", 
      "title": "Weightage or placement of the widget or container", 
      "type": "int"
    }, 
    "widgets": {
      "description": "Array of widgets that are part of the multi-widget.", 
      "items": {
        "$ref": "WidgetItem
      }, 
      "maxItems": 2, 
      "minItems": 1, 
      "required": true, 
      "title": "Widgets", 
      "type": "array"
    }
  }, 
  "title": "Multi-Widget", 
  "type": "object"
}

NSXTConnectionInfo (type)

{
  "additionalProperties": false, 
  "description": "Credential info to connect to an NSX-T type of enforcement point.", 
  "extends": {
    "$ref": "EnforcementPointConnectionInfo
  }, 
  "id": "NSXTConnectionInfo", 
  "module_id": "PolicyEnforcementPointManagement", 
  "polymorphic-type-descriptor": {
    "type-identifier": "NSXTConnectionInfo"
  }, 
  "properties": {
    "edge_cluster_ids": {
      "deprecated": true, 
      "description": "Edge Cluster UUIDs on enforcement point. Edge cluster information is required for creating logical L2, L3 constructs on enforcement point. Max 1 edge cluster ID. This is a deprecated property. The edge cluster id is now auto populated from enforcement point and its value can be read using APIs GET /infra/sites/site-id/enforcement-points/enforcementpoint-id/edge-clusters and GET /infra/sites/site-id/enforcement-points/enforcementpoint-1/edge-clusters/edge-cluster-id. The value passed through this property will be ignored.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 1, 
      "required": false, 
      "title": "Edge Cluster IDs", 
      "type": "array"
    }, 
    "enforcement_point_address": {
      "description": "Value of this property could be Hostname or IP. For instance: - On an NSX-T MP running on default port, the value could be \"10.192.1.1\" - On an NSX-T MP running on custom port, the value could be \"192.168.1.1:32789\" - On an NSX-T MP in VMC deployments, the value could be \"192.168.1.1:5480/nsxapi\"", 
      "required": true, 
      "title": "Enforcement Point Address", 
      "type": "string"
    }, 
    "password": {
      "description": "Password.", 
      "sensitive": true, 
      "title": "Password", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "Resource Type of Enforcement Point Connection Info.", 
      "enum": [
        "NSXTConnectionInfo", 
        "NSXVConnectionInfo", 
        "CvxConnectionInfo"
      ], 
      "required": true, 
      "title": "Connection Info Resource Type", 
      "type": "string"
    }, 
    "thumbprint": {
      "description": "Thumbprint of EnforcementPoint in the form of a SHA-256 hash represented in lower case HEX.", 
      "title": "Thumbprint of Enforcement Point", 
      "type": "string"
    }, 
    "transport_zone_ids": {
      "deprecated": true, 
      "description": "Transport Zone UUIDs on enforcement point. Transport zone information is required for creating logical L2, L3 constructs on enforcement point. Max 1 transport zone ID. This is a deprecated property. The transport zone id is now auto populated from enforcement point and its value can be read using APIs GET /infra/sites/site-id/enforcement-points/enforcementpoint-id/transport-zones and GET /infra/sites/site-id/enforcement-points/enforcementpoint-id/transport-zones/transport-zone-id. The value passed through this property will be ignored.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 1, 
      "required": false, 
      "title": "Transport Zone IDs", 
      "type": "array"
    }, 
    "username": {
      "description": "Username.", 
      "title": "Username", 
      "type": "string"
    }
  }, 
  "title": "NSX-T Connection Info", 
  "type": "object"
}

NSXVConnectionInfo (type)

{
  "additionalProperties": false, 
  "description": "Credential info to connect to an NSX-V type of enforcement point.", 
  "extends": {
    "$ref": "EnforcementPointConnectionInfo
  }, 
  "id": "NSXVConnectionInfo", 
  "module_id": "PolicyEnforcementPointManagement", 
  "polymorphic-type-descriptor": {
    "type-identifier": "NSXVConnectionInfo"
  }, 
  "properties": {
    "enforcement_point_address": {
      "description": "Value of this property could be Hostname or IP. For instance: - On an NSX-T MP running on default port, the value could be \"10.192.1.1\" - On an NSX-T MP running on custom port, the value could be \"192.168.1.1:32789\" - On an NSX-T MP in VMC deployments, the value could be \"192.168.1.1:5480/nsxapi\"", 
      "required": true, 
      "title": "Enforcement Point Address", 
      "type": "string"
    }, 
    "password": {
      "description": "Password.", 
      "required": true, 
      "sensitive": true, 
      "title": "Password", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "Resource Type of Enforcement Point Connection Info.", 
      "enum": [
        "NSXTConnectionInfo", 
        "NSXVConnectionInfo", 
        "CvxConnectionInfo"
      ], 
      "required": true, 
      "title": "Connection Info Resource Type", 
      "type": "string"
    }, 
    "thumbprint": {
      "description": "Thumbprint of EnforcementPoint in the form of a SHA-256 hash represented in lower case HEX.", 
      "required": true, 
      "title": "Thumbprint of Enforcement Point", 
      "type": "string"
    }, 
    "username": {
      "description": "Username.", 
      "required": true, 
      "sensitive": true, 
      "title": "Username", 
      "type": "string"
    }
  }, 
  "title": "NSX-V Connection Info", 
  "type": "object"
}

NdSnoopingConfig (type)

{
  "additionalProperties": false, 
  "description": "Contains Neighbor Discovery Protocol (ND) snooping related configuration.", 
  "id": "NdSnoopingConfig", 
  "module_id": "PolicyIpDiscovery", 
  "properties": {
    "nd_snooping_enabled": {
      "default": false, 
      "description": "Enable this method will snoop the NS (Neighbor Solicitation) and NA (Neighbor Advertisement) messages in the ND (Neighbor Discovery Protocol) family of messages which are transmitted by a VM. From the NS messages, we will learn about the source which sent this NS message. From the NA message, we will learn the resolved address in the message which the VM is a recipient of. Addresses snooped by this method are subject to TOFU (Trust on First Use) policies as enforced by the system.", 
      "required": false, 
      "title": "Is ND snooping enabled or not", 
      "type": "boolean"
    }, 
    "nd_snooping_limit": {
      "default": 3, 
      "description": "Maximum number of ND (Neighbor Discovery Protocol) snooped IPv6 addresses", 
      "maximum": 15, 
      "minimum": 2, 
      "required": false, 
      "title": "Maximum number of ND (Neighbor Discovery Protocol) bindings", 
      "type": "int"
    }
  }, 
  "title": "ND Snooping Configuration", 
  "type": "object"
}

NdpHeader (type)

{
  "additionalProperties": false, 
  "id": "NdpHeader", 
  "module_id": "Traceflow", 
  "properties": {
    "dst_ip": {
      "$ref": "IPv6Address, 
      "description": "The IP address of the destination of the solicitation. It MUST NOT be a multicast address.", 
      "required": false, 
      "title": "The destination IP address"
    }, 
    "msg_type": {
      "default": "NEIGHBOR_SOLICITATION", 
      "description": "This field specifies the type of the Neighbor discover message being sent. NEIGHBOR_SOLICITATION - Neighbor Solicitation message to discover the link-layer address of an on-link IPv6 node or to confirm a previously determined link-layer address. NEIGHBOR_ADVERTISEMENT - Neighbor Advertisement message in response to a Neighbor Solicitation message.", 
      "enum": [
        "NEIGHBOR_SOLICITATION", 
        "NEIGHBOR_ADVERTISEMENT"
      ], 
      "title": "NDP message type", 
      "type": "string"
    }
  }, 
  "title": "Neighbor discovery protocol header", 
  "type": "object"
}

NestedExpression (type)

{
  "additionalProperties": false, 
  "description": "Nested expressions is a list of condition expressions that must follow the below criteria: 0. Only allowed expressions in a NestedExpression are Condition and ConjunctionOperator. 1. A non-empty expression list, must be of odd size. In a list, with indices starting from 0, all condition expressions must be at even indices, separated by the conjunction expressions AND at odd indices. 2. There may be at most 5 condition expressions inside a list. 3. NestedExpressions are homogeneous in nature, i.e, all expressions inside a nested expression must have the same member type.", 
  "extends": {
    "$ref": "Expression
  }, 
  "id": "NestedExpression", 
  "module_id": "Policy", 
  "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: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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"
    }, 
    "expressions": {
      "description": "Expression.", 
      "items": {
        "$ref": "Expression
      }, 
      "minItems": 1, 
      "required": true, 
      "title": "Expression", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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", 
        "ExternalIDExpression", 
        "PathExpression", 
        "IdentityGroupExpression"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "NestedExpression", 
  "type": "object"
}

NestedServiceServiceEntry (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ServiceEntry
  }, 
  "id": "NestedServiceServiceEntry", 
  "module_id": "Policy", 
  "polymorphic-type-descriptor": {
    "type-identifier": "NestedServiceServiceEntry"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "nested_service_path": {
      "required": true, 
      "title": "path of nested service", 
      "type": "string"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": [
        "IPProtocolServiceEntry", 
        "IGMPTypeServiceEntry", 
        "ICMPTypeServiceEntry", 
        "ALGTypeServiceEntry", 
        "L4PortSetServiceEntry", 
        "EtherTypeServiceEntry", 
        "NestedServiceServiceEntry"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "A ServiceEntry that represents nesting service", 
  "type": "object"
}

NetworkError (type)

{
  "description": "Network error related to container objects.", 
  "id": "NetworkError", 
  "module_id": "InventoryContainerObj", 
  "properties": {
    "error_code": {
      "description": "Error code of network related error.", 
      "readonly": true, 
      "required": false, 
      "title": "Error code", 
      "type": "string"
    }, 
    "error_message": {
      "description": "Detailed message of network related error.", 
      "readonly": true, 
      "required": false, 
      "title": "Error message", 
      "type": "string"
    }, 
    "spec": {
      "description": "Additional error information in json format.", 
      "readonly": true, 
      "required": false, 
      "title": "Other specifications", 
      "type": "string"
    }
  }, 
  "title": "Network Error", 
  "type": "object"
}

NewRole (type)

{
  "id": "NewRole", 
  "module_id": "AAA", 
  "properties": {
    "new_role_description": {
      "required": false, 
      "title": "New role description", 
      "type": "string"
    }, 
    "new_role_id": {
      "pattern": "^[_a-z0-9-]+$", 
      "required": true, 
      "title": "New role id", 
      "type": "string"
    }, 
    "new_role_name": {
      "required": true, 
      "title": "New role name", 
      "type": "string"
    }
  }, 
  "title": "New Role", 
  "type": "object"
}

NoRestRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "Parameter definition for requests that do not allow parameters.", 
  "id": "NoRestRequestParameters", 
  "module_id": "Types", 
  "properties": {}, 
  "type": "object"
}

NodeAsyncReplicatorServiceProperties (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "NodeServiceProperties
  }, 
  "id": "NodeAsyncReplicatorServiceProperties", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "service_name": {
      "required": true, 
      "title": "Service name", 
      "type": "string"
    }, 
    "service_properties": {
      "$ref": "LoggingServiceProperties, 
      "title": "Service properties"
    }
  }, 
  "title": "Node service 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"
    }, 
    "lb_enable": {
      "required": false, 
      "title": "Load Balancer enable flag", 
      "type": "boolean"
    }, 
    "node_host_name": {
      "description": "host name to use when creating the redirect URL for clients to follow after authenticating to vIDM", 
      "required": true, 
      "title": "host name of the node redirected to", 
      "type": "string"
    }, 
    "thumbprint": {
      "description": "Hexadecimal SHA256 hash of the vIDM server's X.509 certificate", 
      "required": true, 
      "title": "vIDM certificate thumbprint", 
      "type": "string"
    }, 
    "vidm_enable": {
      "required": false, 
      "title": "vIDM enable flag", 
      "type": "boolean"
    }
  }, 
  "title": "Node AAA provider vIDM properties", 
  "type": "object"
}

NodeAuthProviderVidmStatus (type)

{
  "additionalProperties": false, 
  "id": "NodeAuthProviderVidmStatus", 
  "properties": {
    "runtime_state": {
      "required": true, 
      "title": "AAA provider vIDM status", 
      "type": "string"
    }, 
    "vidm_enable": {
      "required": true, 
      "title": "vIDM enable flag", 
      "type": "boolean"
    }
  }, 
  "title": "Node AAA provider vIDM status", 
  "type": "object"
}

NodeFileSystemProperties (type)

{
  "additionalProperties": false, 
  "id": "NodeFileSystemProperties", 
  "module_id": "ApplianceStats", 
  "properties": {
    "file_system": {
      "readonly": true, 
      "title": "File system id", 
      "type": "string"
    }, 
    "mount": {
      "readonly": true, 
      "title": "File system mount", 
      "type": "string"
    }, 
    "total": {
      "readonly": true, 
      "title": "File system size in kilobytes", 
      "type": "integer"
    }, 
    "type": {
      "readonly": true, 
      "title": "File system type", 
      "type": "string"
    }, 
    "used": {
      "readonly": true, 
      "title": "Amount of file system used in kilobytes", 
      "type": "integer"
    }
  }, 
  "title": "File system properties", 
  "type": "object"
}

NodeGlobalManagerServiceProperties (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "NodeServiceProperties
  }, 
  "id": "NodeGlobalManagerServiceProperties", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "service_name": {
      "required": true, 
      "title": "Service name", 
      "type": "string"
    }, 
    "service_properties": {
      "$ref": "LoggingServiceProperties, 
      "title": "Service properties"
    }
  }, 
  "title": "Node service properties", 
  "type": "object"
}

NodeHttpServiceProperties (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "NodeServiceProperties
  }, 
  "id": "NodeHttpServiceProperties", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "service_name": {
      "required": true, 
      "title": "Service name", 
      "type": "string"
    }, 
    "service_properties": {
      "$ref": "HttpServiceProperties, 
      "title": "HTTP Service properties"
    }
  }, 
  "title": "Node HTTP service properties", 
  "type": "object"
}

NodeIdServicesMap (type)

{
  "additionalProperties": false, 
  "id": "NodeIdServicesMap", 
  "module_id": "CertificateManager", 
  "properties": {
    "node_id": {
      "maxLength": 255, 
      "readonly": false, 
      "required": true, 
      "title": "NodeId", 
      "type": "string"
    }, 
    "service_types": {
      "description": "List of ServiceTypes.", 
      "items": {
        "$ref": "ServiceType
      }, 
      "readonly": false, 
      "required": true, 
      "type": "array"
    }
  }, 
  "type": "object"
}

NodeInfo (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "NodeInfo", 
  "module_id": "Upgrade", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "component_version": {
      "readonly": true, 
      "required": true, 
      "title": "Component version of the node", 
      "type": "string"
    }, 
    "display_name": {
      "readonly": true, 
      "required": true, 
      "title": "Name of the node", 
      "type": "string"
    }, 
    "id": {
      "description": "Identifier of the node", 
      "readonly": true, 
      "required": true, 
      "title": "UUID of node", 
      "type": "string"
    }, 
    "type": {
      "readonly": true, 
      "required": true, 
      "title": "Node type", 
      "type": "string"
    }
  }, 
  "type": "object"
}

NodeInfoListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "NodeInfoListRequestParameters", 
  "module_id": "Upgrade", 
  "properties": {
    "component_type": {
      "readonly": false, 
      "required": false, 
      "title": "Component type based on which nodes will be filtered", 
      "type": "string"
    }, 
    "component_version": {
      "readonly": false, 
      "required": false, 
      "title": "Component version based on which nodes will be filtered", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

NodeInfoListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "NodeInfoListResult", 
  "module_id": "Upgrade", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "NodeInfo
      }, 
      "required": true, 
      "title": "Paged Collection of Nodes", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

NodeInstallUpgradeServiceProperties (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "NodeServiceProperties
  }, 
  "id": "NodeInstallUpgradeServiceProperties", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "service_name": {
      "required": true, 
      "title": "Service name", 
      "type": "string"
    }, 
    "service_properties": {
      "$ref": "InstallUpgradeServiceProperties, 
      "title": "install-upgrade Service properties"
    }
  }, 
  "title": "Node install-upgrade service properties", 
  "type": "object"
}

NodeInterfaceStatisticsProperties (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "NodeInterfaceStatisticsProperties", 
  "module_id": "ApplianceStats", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "interface_id": {
      "title": "Interface ID", 
      "type": "string"
    }, 
    "rx_bytes": {
      "title": "Number of bytes received", 
      "type": "integer"
    }, 
    "rx_dropped": {
      "title": "Number of packets dropped", 
      "type": "integer"
    }, 
    "rx_errors": {
      "title": "Number of receive errors", 
      "type": "integer"
    }, 
    "rx_frame": {
      "title": "Number of framing errors", 
      "type": "integer"
    }, 
    "rx_packets": {
      "title": "Number of packets received", 
      "type": "integer"
    }, 
    "source": {
      "$ref": "DataSourceType, 
      "title": "Source of status data."
    }, 
    "tx_bytes": {
      "title": "Number of bytes transmitted", 
      "type": "integer"
    }, 
    "tx_carrier": {
      "title": "Number of carrier losses detected", 
      "type": "integer"
    }, 
    "tx_colls": {
      "title": "Number of collisions detected", 
      "type": "integer"
    }, 
    "tx_dropped": {
      "title": "Number of packets dropped", 
      "type": "integer"
    }, 
    "tx_errors": {
      "title": "Number of transmit errors", 
      "type": "integer"
    }, 
    "tx_packets": {
      "title": "Number of packets transmitted", 
      "type": "integer"
    }
  }, 
  "title": "Node network interface statistic properties", 
  "type": "object"
}

NodeLogProperties (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "NodeLogProperties", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "readonly": true, 
      "title": "Last modified time expressed in milliseconds since epoch"
    }, 
    "log_name": {
      "readonly": true, 
      "title": "Name of log file", 
      "type": "string"
    }, 
    "log_size": {
      "readonly": true, 
      "title": "Size of log file in bytes", 
      "type": "integer"
    }
  }, 
  "title": "Node log properties", 
  "type": "object"
}

NodeLogPropertiesListResult (type)

{
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "NodeLogPropertiesListResult", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "NodeLogProperties
      }, 
      "required": true, 
      "title": "Node log property results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Node log property query results", 
  "type": "object"
}

NodeNameServersProperties (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "NodeNameServersProperties", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "name_servers": {
      "items": {
        "type": "string"
      }, 
      "maxItems": 3, 
      "required": true, 
      "title": "Name servers", 
      "type": "array"
    }
  }, 
  "title": "Node network name servers properties", 
  "type": "object"
}

NodeNetworkInterfaceProperties (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "NodeNetworkInterfaceProperties", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "admin_status": {
      "enum": [
        "up", 
        "down"
      ], 
      "readonly": true, 
      "title": "Interface administration status", 
      "type": "string"
    }, 
    "bond_mode": {
      "enum": [
        "ACTIVE_BACKUP", 
        "802_3AD", 
        "ROUND_ROBIN", 
        "BROADCAST", 
        "XOR", 
        "TLB", 
        "ALB"
      ], 
      "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"
    }, 
    "is_kni": {
      "readonly": true, 
      "title": "Interface is a KNI", 
      "type": "boolean"
    }, 
    "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", 
        "none"
      ], 
      "title": "Interface plane", 
      "type": "string"
    }, 
    "vlan": {
      "maximum": 4094, 
      "minimum": 1, 
      "readonly": true, 
      "title": "VLAN Id", 
      "type": "integer"
    }
  }, 
  "title": "Node network interface properties", 
  "type": "object"
}

NodeNetworkInterfacePropertiesListResult (type)

{
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "NodeNetworkInterfacePropertiesListResult", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "NodeNetworkInterfaceProperties
      }, 
      "required": true, 
      "title": "Node network interface property results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Node network interface properties list results", 
  "type": "object"
}

NodeNetworkProperties (type)

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

NodeNtpServiceProperties (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "NodeServiceProperties
  }, 
  "id": "NodeNtpServiceProperties", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "service_name": {
      "required": true, 
      "title": "Service name", 
      "type": "string"
    }, 
    "service_properties": {
      "$ref": "NtpServiceProperties, 
      "title": "NTP Service properties"
    }
  }, 
  "title": "Node NTP service properties", 
  "type": "object"
}

NodeProcessProperties (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "NodeProcessProperties", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cpu_time": {
      "readonly": true, 
      "title": "CPU time (user and system) consumed by process in milliseconds", 
      "type": "integer"
    }, 
    "mem_resident": {
      "readonly": true, 
      "title": "Resident set size of process in bytes", 
      "type": "integer"
    }, 
    "mem_used": {
      "readonly": true, 
      "title": "Virtual memory used by process in bytes", 
      "type": "integer"
    }, 
    "pid": {
      "readonly": true, 
      "title": "Process id", 
      "type": "integer"
    }, 
    "ppid": {
      "readonly": true, 
      "title": "Parent process id", 
      "type": "integer"
    }, 
    "process_name": {
      "readonly": true, 
      "title": "Process name", 
      "type": "string"
    }, 
    "start_time": {
      "$ref": "EpochMsTimestamp, 
      "readonly": true, 
      "title": "Process start time expressed in milliseconds since epoch"
    }, 
    "uptime": {
      "readonly": true, 
      "title": "Milliseconds since process started", 
      "type": "integer"
    }
  }, 
  "title": "Node process properties", 
  "type": "object"
}

NodeProcessPropertiesListResult (type)

{
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "NodeProcessPropertiesListResult", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "NodeProcessProperties
      }, 
      "required": true, 
      "title": "Node process property results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Node process property query results", 
  "type": "object"
}

NodeProperties (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "NodeProperties", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cli_output_datetime": {
      "title": "NSX CLI display datetime stamp in command output", 
      "type": "boolean"
    }, 
    "cli_timeout": {
      "minimum": 0, 
      "title": "NSX CLI inactivity timeout, set to 0 to configure no timeout", 
      "type": "integer"
    }, 
    "export_type": {
      "enum": [
        "RESTRICTED", 
        "UNRESTRICTED"
      ], 
      "readonly": true, 
      "title": "Export restrictions in effect, if any", 
      "type": "string"
    }, 
    "fully_qualified_domain_name": {
      "readonly": true, 
      "title": "Fully qualified domain name", 
      "type": "string"
    }, 
    "hostname": {
      "$ref": "SystemHostname, 
      "title": "Host name or fully qualified domain name of node", 
      "type": "string"
    }, 
    "kernel_version": {
      "readonly": true, 
      "title": "Kernel version", 
      "type": "string"
    }, 
    "motd": {
      "title": "Message of the day to display when users login to node using the NSX CLI", 
      "type": [
        "string", 
        "null"
      ]
    }, 
    "node_uuid": {
      "maxLength": 36, 
      "readonly": true, 
      "title": "Node Unique Identifier", 
      "type": "string"
    }, 
    "node_version": {
      "readonly": true, 
      "title": "Node version", 
      "type": "string"
    }, 
    "product_version": {
      "readonly": true, 
      "title": "Product version", 
      "type": "string"
    }, 
    "system_datetime": {
      "$ref": "DatetimeUTC, 
      "title": "System date time in UTC"
    }, 
    "system_time": {
      "$ref": "EpochMsTimestamp, 
      "readonly": true, 
      "title": "Current time expressed in milliseconds since epoch"
    }, 
    "timezone": {
      "title": "Timezone", 
      "type": "string"
    }
  }, 
  "title": "Node properties", 
  "type": "object"
}

NodeProtonServiceProperties (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "NodeServiceProperties
  }, 
  "id": "NodeProtonServiceProperties", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "service_name": {
      "required": true, 
      "title": "Service name", 
      "type": "string"
    }, 
    "service_properties": {
      "$ref": "LoggingServiceProperties, 
      "title": "Service properties"
    }
  }, 
  "title": "Node service properties", 
  "type": "object"
}

NodeRouteProperties (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "NodeRouteProperties", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "destination": {
      "title": "Destination covered by route", 
      "type": "string"
    }, 
    "from_address": {
      "pattern": "^[\\d]{1,3}\\.[\\d]{1,3}\\.[\\d]{1,3}\\.[\\d]{1,3}$", 
      "title": "From address", 
      "type": "string"
    }, 
    "gateway": {
      "pattern": "^[\\d]{1,3}\\.[\\d]{1,3}\\.[\\d]{1,3}\\.[\\d]{1,3}$", 
      "title": "Address of next hop", 
      "type": "string"
    }, 
    "interface_id": {
      "title": "Network interface id of route", 
      "type": "string"
    }, 
    "metric": {
      "title": "Metric value of route", 
      "type": "string"
    }, 
    "netmask": {
      "pattern": "^[\\d]{1,3}\\.[\\d]{1,3}\\.[\\d]{1,3}\\.[\\d]{1,3}$", 
      "title": "Netmask of destination covered by route", 
      "type": "string"
    }, 
    "proto": {
      "default": "boot", 
      "enum": [
        "unspec", 
        "redirect", 
        "kernel", 
        "boot", 
        "static", 
        "gated", 
        "ra", 
        "mrt", 
        "zebra", 
        "bird", 
        "dnrouted", 
        "xorp", 
        "ntk", 
        "dhcp"
      ], 
      "title": "Routing protocol identifier of route", 
      "type": "string"
    }, 
    "route_id": {
      "readonly": true, 
      "title": "Unique identifier for the route", 
      "type": "string"
    }, 
    "route_type": {
      "enum": [
        "default", 
        "static", 
        "blackhole", 
        "prohibit", 
        "throw", 
        "unreachable"
      ], 
      "required": true, 
      "title": "Route type", 
      "type": "string"
    }, 
    "scope": {
      "title": "Scope of destinations covered by route", 
      "type": "string"
    }, 
    "src": {
      "pattern": "^[\\d]{1,3}\\.[\\d]{1,3}\\.[\\d]{1,3}\\.[\\d]{1,3}$", 
      "title": "Source address to prefer when sending to destinations of route", 
      "type": "string"
    }
  }, 
  "title": "Node network route properties", 
  "type": "object"
}

NodeRoutePropertiesListResult (type)

{
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "NodeRoutePropertiesListResult", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "NodeRouteProperties
      }, 
      "required": true, 
      "title": "Node route property results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Node network route properties list results", 
  "type": "object"
}

NodeSearchDomainsProperties (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "NodeSearchDomainsProperties", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "search_domains": {
      "items": {
        "type": "string"
      }, 
      "required": true, 
      "title": "Search domains", 
      "type": "array"
    }
  }, 
  "title": "Node network search domains properties", 
  "type": "object"
}

NodeServiceProperties (type)

{
  "extends": {
    "$ref": "Resource
  }, 
  "id": "NodeServiceProperties", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "service_name": {
      "required": true, 
      "title": "Service name", 
      "type": "string"
    }
  }, 
  "title": "Node service properties", 
  "type": "object"
}

NodeServicePropertiesListResult (type)

{
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "NodeServicePropertiesListResult", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "NodeServiceProperties
      }, 
      "required": true, 
      "title": "Node service property results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Node service property query results", 
  "type": "object"
}

NodeServiceStatusProperties (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "NodeServiceStatusProperties", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "health": {
      "enum": [
        "STABLE", 
        "DEGRADED"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Service health in addition to runtime_state", 
      "type": "string"
    }, 
    "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"
    }, 
    "reason": {
      "readonly": true, 
      "required": false, 
      "title": "Reason for service degradation", 
      "type": "string"
    }, 
    "runtime_state": {
      "enum": [
        "running", 
        "stopped"
      ], 
      "readonly": true, 
      "title": "Service runtime state", 
      "type": "string"
    }
  }, 
  "title": "Node service status properties", 
  "type": "object"
}

NodeSnmpServiceProperties (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "NodeServiceProperties
  }, 
  "id": "NodeSnmpServiceProperties", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "service_name": {
      "required": true, 
      "title": "Service name", 
      "type": "string"
    }, 
    "service_properties": {
      "$ref": "SnmpServiceProperties, 
      "required": true, 
      "title": "SNMP Service properties"
    }
  }, 
  "title": "Node SNMP service properties", 
  "type": "object"
}

NodeSnmpV3EngineID (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "NodeServiceProperties
  }, 
  "id": "NodeSnmpV3EngineID", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "service_name": {
      "required": true, 
      "title": "Service name", 
      "type": "string"
    }, 
    "v3_engine_id": {
      "required": true, 
      "title": "SNMP v3 engine id", 
      "type": "string"
    }
  }, 
  "title": "SNMP V3 Engine Id", 
  "type": "object"
}

NodeSshServiceProperties (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "NodeServiceProperties
  }, 
  "id": "NodeSshServiceProperties", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "service_name": {
      "required": true, 
      "title": "Service name", 
      "type": "string"
    }, 
    "service_properties": {
      "$ref": "SshServiceProperties, 
      "title": "SSH Service properties"
    }
  }, 
  "title": "Node SSH service properties", 
  "type": "object"
}

NodeStatusProperties (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "NodeStatusProperties", 
  "module_id": "ApplianceStats", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cpu_cores": {
      "readonly": true, 
      "title": "Number of CPU cores on the system", 
      "type": "integer"
    }, 
    "cpu_usage": {
      "$ref": "CpuUsage, 
      "description": "Highest and average usage of DPDK and non-DPDK core of Edge Node.", 
      "readonly": true, 
      "title": "CPU usage of DPDK and non-DPDK core groups"
    }, 
    "disk_space_total": {
      "description": "Amount of disk space available on the system, in kilobytes.", 
      "readonly": true, 
      "title": "Amount of disk space available on the system, in kilobytes", 
      "type": "integer"
    }, 
    "disk_space_used": {
      "descrption": "Amount of disk space in use on the system, in kilobytes.", 
      "readonly": true, 
      "title": "Amount of disk space in use on the system, in kilobytes", 
      "type": "integer"
    }, 
    "dpdk_cpu_cores": {
      "description": "Number of DPDK cores on Edge Node which are used for packet IO processing.", 
      "readonly": true, 
      "title": "Number of DPDK CPU cores on the system", 
      "type": "integer"
    }, 
    "edge_mem_usage": {
      "$ref": "EdgeTransportNodeMemoryUsage, 
      "description": "Point in time usage of system, datapath, swap and cache memory in edge node. Valid only for Edge transport node.", 
      "readonly": true, 
      "title": "Memory usage of edge node"
    }, 
    "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"
    }, 
    "non_dpdk_cpu_cores": {
      "description": "Number of non-DPDK cores on Edge Node.", 
      "readonly": true, 
      "title": "Number of non-DPDK CPU cores on the system", 
      "type": "integer"
    }, 
    "source": {
      "$ref": "DataSourceType, 
      "readonly": true, 
      "title": "Source of status data."
    }, 
    "swap_total": {
      "readonly": true, 
      "title": "Amount of disk available for swap, in kilobytes", 
      "type": "integer"
    }, 
    "swap_used": {
      "readonly": true, 
      "title": "Amount of swap disk in use, in kilobytes", 
      "type": "integer"
    }, 
    "system_time": {
      "$ref": "EpochMsTimestamp, 
      "readonly": true, 
      "title": "Current time expressed in milliseconds since epoch"
    }, 
    "uptime": {
      "readonly": true, 
      "title": "Milliseconds since system start", 
      "type": "integer"
    }
  }, 
  "title": "Node status properties", 
  "type": "object"
}

NodeSummary (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "NodeSummary", 
  "module_id": "Upgrade", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "component_version": {
      "readonly": true, 
      "required": true, 
      "title": "Component version", 
      "type": "string"
    }, 
    "node_count": {
      "description": "Number of nodes of the type and at the component version", 
      "readonly": true, 
      "required": true, 
      "title": "Count of nodes", 
      "type": "int"
    }, 
    "type": {
      "readonly": true, 
      "required": true, 
      "title": "Node type", 
      "type": "string"
    }
  }, 
  "type": "object"
}

NodeSummaryList (type)

{
  "additionalProperties": false, 
  "id": "NodeSummaryList", 
  "module_id": "Upgrade", 
  "properties": {
    "results": {
      "items": {
        "$ref": "NodeSummary
      }, 
      "required": true, 
      "title": "List of Node Summary", 
      "type": "array"
    }
  }, 
  "type": "object"
}

NodeSyslogExporterProperties (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "NodeSyslogExporterProperties", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "exporter_name": {
      "required": true, 
      "title": "Syslog exporter name", 
      "type": "string"
    }, 
    "facilities": {
      "items": {
        "$ref": "SyslogFacility
      }, 
      "title": "Facilities to export", 
      "type": "array"
    }, 
    "level": {
      "enum": [
        "EMERG", 
        "ALERT", 
        "CRIT", 
        "ERR", 
        "WARNING", 
        "NOTICE", 
        "INFO", 
        "DEBUG"
      ], 
      "required": true, 
      "title": "Logging level to export", 
      "type": "string"
    }, 
    "msgids": {
      "items": {
        "pattern": "^.+$", 
        "type": "string"
      }, 
      "title": "MSGIDs to export", 
      "type": "array"
    }, 
    "port": {
      "maximum": 65535, 
      "minimum": 1, 
      "title": "Port to export to, defaults to 514 for TCP, TLS, UDP protocols or 9000 for LI, LI-TLS protocols", 
      "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": "^(alarmId|alarmState|audit|comp|entId|eReqId|errorCode|eventFeatureName|eventId|eventSev|eventState|eventType|euser|level|nodeId|security|subcomp|s2comp|splitId|splitIndex|tenantId|tid|tname|update|username)=.+$", 
        "type": "string"
      }, 
      "title": "Structured data to export", 
      "type": "array"
    }, 
    "tls_ca_pem": {
      "title": "CA certificate PEM of TLS server to export to", 
      "type": "string"
    }, 
    "tls_cert_pem": {
      "title": "Certificate PEM of the rsyslog client", 
      "type": "string"
    }, 
    "tls_client_ca_pem": {
      "title": "CA certificate PEM of the rsyslog client", 
      "type": "string"
    }, 
    "tls_key_pem": {
      "sensitive": true, 
      "title": "Private key PEM of the rsyslog client", 
      "type": "string"
    }
  }, 
  "title": "Node syslog exporter properties", 
  "type": "object"
}

NodeSyslogExporterPropertiesListResult (type)

{
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "NodeSyslogExporterPropertiesListResult", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "NodeSyslogExporterProperties
      }, 
      "required": true, 
      "title": "Node syslog exporter results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Node syslog exporter list results", 
  "type": "object"
}

NodeTime (type)

{
  "additionalProperties": false, 
  "description": "Node system time in UTC", 
  "id": "NodeTime", 
  "properties": {
    "system_datetime": {
      "$ref": "DatetimeUTC, 
      "required": true, 
      "title": "Datetime string in UTC"
    }
  }, 
  "title": "Node system time in UTC", 
  "type": "object"
}

NodeUserPasswordProperty (type)

{
  "additionalProperties": false, 
  "id": "NodeUserPasswordProperty", 
  "properties": {
    "password": {
      "required": true, 
      "sensitive": true, 
      "title": "The new password for user", 
      "type": "string"
    }
  }, 
  "type": "object"
}

NodeUserProperties (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "NodeUserProperties", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "full_name": {
      "title": "Full name for the user", 
      "type": "string"
    }, 
    "last_password_change": {
      "maximum": 2147483647, 
      "minimum": 0, 
      "readonly": true, 
      "title": "Number of days since password was last changed", 
      "type": "integer"
    }, 
    "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"
    }, 
    "password_change_frequency": {
      "description": "Number of days password is valid before it must be changed. This can be set to 0 to indicate no password change is required or a positive integer up to 9999. By default local user passwords must be changed every 90 days.", 
      "maximum": 9999, 
      "minimum": 0, 
      "title": "Number of days password is valid before it must be changed", 
      "type": "integer"
    }, 
    "status": {
      "description": "Status of the user. This value can be ACTIVE indicating authentication attempts will be successful if the correct credentials are specified. The value can also be PASSWORD_EXPIRED indicating authentication attempts will fail because the user's password has expired and must be changed. Or, this value can be NOT_ACTIVATED indicating the user's password has not yet been set and must be set before the user can authenticate.", 
      "enum": [
        "ACTIVE", 
        "PASSWORD_EXPIRED", 
        "NOT_ACTIVATED"
      ], 
      "readonly": true, 
      "title": "User status", 
      "type": "string"
    }, 
    "userid": {
      "maximum": 2147483647, 
      "minimum": 0, 
      "readonly": true, 
      "title": "Numeric id for the user", 
      "type": "integer"
    }, 
    "username": {
      "maxLength": 32, 
      "minLength": 1, 
      "pattern": "^[a-zA-Z][a-zA-Z0-9@-_.\\-]*$", 
      "title": "User login name (must be \"root\" if userid is 0)", 
      "type": "string"
    }
  }, 
  "title": "Node user properties", 
  "type": "object"
}

NodeUserPropertiesListResult (type)

{
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "NodeUserPropertiesListResult", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "NodeUserProperties
      }, 
      "required": true, 
      "title": "List of node users", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Node users list results", 
  "type": "object"
}

NodeVersion (type)

{
  "additionalProperties": false, 
  "id": "NodeVersion", 
  "properties": {
    "node_version": {
      "readonly": true, 
      "title": "Node version", 
      "type": "string"
    }, 
    "product_version": {
      "readonly": true, 
      "title": "Product version", 
      "type": "string"
    }
  }, 
  "type": "object"
}

NsxRole (type)

{
  "id": "NsxRole", 
  "module_id": "AAA", 
  "properties": {
    "permissions": {
      "deprecated": true, 
      "description": "Please use the /user-info/permissions api to get the permission that the user has on each feature.", 
      "items": {
        "enum": [
          "read-api", 
          "read-write-api", 
          "crud", 
          "read", 
          "execute", 
          "none"
        ], 
        "type": "string"
      }, 
      "required": false, 
      "title": "Permissions", 
      "type": "array"
    }, 
    "role": {
      "description": "This field represents the identifier of the role. With the introduction of custom roles, this field is no longer an enum.", 
      "required": true, 
      "title": "Role ID", 
      "type": "string"
    }
  }, 
  "title": "Role", 
  "type": "object"
}

NsxTDNSForwarderStatistics (type)

{
  "description": "The current statistics counters of the DNS forwarder including cache usages and query numbers per forwarders, on an NSX-T type of enforcement point.", 
  "extends": {
    "$ref": "DNSForwarderStatisticsPerEnforcementPoint
  }, 
  "id": "NsxTDNSForwarderStatistics", 
  "module_id": "PolicyDNSStatistics", 
  "polymorphic-type-descriptor": {
    "type-identifier": "NsxTDNSForwarderStatistics"
  }, 
  "properties": {
    "cached_entries": {
      "readonly": true, 
      "title": "The total number of cached entries", 
      "type": "integer"
    }, 
    "conditional_forwarder_statistics": {
      "items": {
        "$ref": "NsxTDNSForwarderZoneStatistics
      }, 
      "maxItems": 5, 
      "minItems": 0, 
      "readonly": true, 
      "required": false, 
      "title": "The statistics of conditional forwarder zones", 
      "type": "array"
    }, 
    "configured_cache_size": {
      "readonly": true, 
      "title": "The configured cache size, in kb", 
      "type": "integer"
    }, 
    "default_forwarder_statistics": {
      "$ref": "NsxTDNSForwarderZoneStatistics, 
      "readonly": true, 
      "title": "The statistics of default forwarder zone"
    }, 
    "enforcement_point_path": {
      "description": "Policy path referencing the enforcement point from where the statistics are fetched.", 
      "readonly": true, 
      "title": "Enforcement point path", 
      "type": "string"
    }, 
    "queries_answered_locally": {
      "readonly": true, 
      "title": "The total number of queries answered from local cache", 
      "type": "integer"
    }, 
    "queries_forwarded": {
      "readonly": true, 
      "title": "The total number of forwarded DNS queries", 
      "type": "integer"
    }, 
    "resource_type": {
      "enum": [
        "NsxTDNSForwarderStatistics"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "timestamp": {
      "$ref": "EpochMsTimestamp, 
      "readonly": true, 
      "title": "Time stamp of the current statistics, in ms"
    }, 
    "total_queries": {
      "readonly": true, 
      "title": "The total number of received DNS queries", 
      "type": "integer"
    }, 
    "used_cache_statistics": {
      "items": {
        "$ref": "NsxTPerNodeUsedCacheStatistics
      }, 
      "maxItems": 2, 
      "minItems": 0, 
      "readonly": true, 
      "required": false, 
      "title": "The statistics of used cache", 
      "type": "array"
    }
  }, 
  "title": "Statistics counters of the DNS forwarder", 
  "type": "object"
}

NsxTDNSForwarderStatus (type)

{
  "description": "The current runtime status of the DNS forwarder.", 
  "extends": {
    "$ref": "DNSForwarderStatusPerEnforcementPoint
  }, 
  "id": "NsxTDNSForwarderStatus", 
  "module_id": "PolicyDNSStatistics", 
  "polymorphic-type-descriptor": {
    "type-identifier": "NsxTDNSForwarderStatus"
  }, 
  "properties": {
    "enforcement_point_path": {
      "description": "Policy path referencing the enforcement point from where the status is fetched.", 
      "readonly": true, 
      "title": "Enforcement point path", 
      "type": "string"
    }, 
    "extra_message": {
      "readonly": true, 
      "required": false, 
      "title": "Extra message, if available", 
      "type": "string"
    }, 
    "resource_type": {
      "enum": [
        "NsxTDNSForwarderStatus"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "status": {
      "description": "UP means the DNS forwarder is working correctly on the active transport node and the stand-by transport node (if present). Failover will occur if either node goes down. DOWN means the DNS forwarder is down on both active transport node and standby node (if present). The DNS forwarder does not function in this situation. Error means there is some error on one or both transport node, or no status was reported from one or both transport nodes. The DNS forwarder may be working (or not working). NO_BACKUP means DNS forwarder is working in only one transport node, either because it is down on the standby node, or no standby is configured. An forwarder outage will occur if the active node goes down.", 
      "enum": [
        "UP", 
        "DOWN", 
        "ERROR", 
        "NO_BACKUP", 
        "UNKNOWN"
      ], 
      "readonly": true, 
      "type": "string"
    }, 
    "timestamp": {
      "$ref": "EpochMsTimestamp, 
      "readonly": true, 
      "title": "Time stamp of the current status, in ms"
    }
  }, 
  "title": "The current runtime status of DNS forwarder", 
  "type": "object"
}

NsxTDNSForwarderZoneStatistics (type)

{
  "description": "Statistics counters of the DNS forwarder zone.", 
  "id": "NsxTDNSForwarderZoneStatistics", 
  "module_id": "PolicyDNSStatistics", 
  "properties": {
    "domain_names": {
      "description": "Domain names configured for the forwarder. Empty if this is the default forwarder.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 100, 
      "minItems": 0, 
      "readonly": true, 
      "title": "Domain names configured for the forwarder", 
      "type": "array"
    }, 
    "upstream_statistics": {
      "items": {
        "$ref": "NsxTUpstreamServerStatistics
      }, 
      "maxItems": 3, 
      "minItems": 0, 
      "readonly": true, 
      "required": false, 
      "title": "Statistics per upstream server.", 
      "type": "array"
    }
  }, 
  "title": "Statistics counters of the DNS forwarder zone", 
  "type": "object"
}

NsxTDnsAnswer (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyDnsAnswerPerEnforcementPoint
  }, 
  "id": "NsxTDnsAnswer", 
  "module_id": "PolicyDnsForwarder", 
  "properties": {
    "authoritative_answers": {
      "items": {
        "$ref": "NsxTDnsQueryAnswer
      }, 
      "maxItems": 256, 
      "minItems": 1, 
      "required": false, 
      "title": "Authoritative answers", 
      "type": "array"
    }, 
    "dns_server": {
      "description": "Dns server ip address and port, format is \"ip address#port\".", 
      "required": true, 
      "title": "Dns server information", 
      "type": "string"
    }, 
    "edge_node_id": {
      "description": "ID of the edge node that performed the query.", 
      "required": true, 
      "title": "Edge node id", 
      "type": "string"
    }, 
    "enforcement_point_path": {
      "description": "Policy path referencing the enforcement point from where the DNS forwarder nslookup answer is fetched.", 
      "readonly": true, 
      "title": "Enforcement point path", 
      "type": "string"
    }, 
    "non_authoritative_answers": {
      "items": {
        "$ref": "NsxTDnsQueryAnswer
      }, 
      "maxItems": 256, 
      "minItems": 1, 
      "required": false, 
      "title": "Non authoritative answers", 
      "type": "array"
    }, 
    "raw_answer": {
      "description": "It can be NXDOMAIN or error message which is not consisted of authoritative_answer or non_authoritative_answer.", 
      "required": false, 
      "title": "Raw message returned from the dns forwarder", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "Resource type of the DNS forwarder nslookup answer.", 
      "enum": [
        "NsxTDnsAnswer"
      ], 
      "required": true, 
      "title": "Resource type", 
      "type": "string"
    }
  }, 
  "title": "Answer of dns nslookup", 
  "type": "object"
}

NsxTDnsQueryAnswer (type)

{
  "additionalProperties": false, 
  "id": "NsxTDnsQueryAnswer", 
  "module_id": "PolicyDnsForwarder", 
  "properties": {
    "address": {
      "description": "Resolved IP address matched with the nslookup address provided as a request parameter.", 
      "required": false, 
      "title": "Matched ip address", 
      "type": "string"
    }, 
    "name": {
      "description": "Matched name of the given address.", 
      "required": false, 
      "title": "Matched name", 
      "type": "string"
    }
  }, 
  "title": "Answer of nslookup", 
  "type": "object"
}

NsxTPerNodeUsedCacheStatistics (type)

{
  "description": "Query statistics counters of used cache from node", 
  "id": "NsxTPerNodeUsedCacheStatistics", 
  "module_id": "PolicyDNSStatistics", 
  "properties": {
    "cached_entries": {
      "readonly": true, 
      "title": "The total number of cached entries", 
      "type": "integer"
    }, 
    "node_id": {
      "readonly": true, 
      "title": "UUID of active/standby transport node", 
      "type": "string"
    }, 
    "used_cache_size": {
      "readonly": true, 
      "title": "The memory size used in cache, in kb", 
      "type": "integer"
    }
  }, 
  "title": "Per node used cache query statistics counters", 
  "type": "object"
}

NsxTUpstreamServerStatistics (type)

{
  "description": "Query statistics counters to an upstream server including successfully forwarded queries and failed queries.", 
  "id": "NsxTUpstreamServerStatistics", 
  "module_id": "PolicyDNSStatistics", 
  "properties": {
    "queries_failed": {
      "readonly": true, 
      "title": "Queries failed to forward.", 
      "type": "integer"
    }, 
    "queries_succeeded": {
      "readonly": true, 
      "title": "Queries forwarded successfully", 
      "type": "integer"
    }, 
    "upstream_server": {
      "$ref": "IPAddress, 
      "readonly": true, 
      "title": "Upstream server ip"
    }
  }, 
  "title": "Upstream server query statistics counters", 
  "type": "object"
}

NtpServiceProperties (type)

{
  "additionalProperties": false, 
  "id": "NtpServiceProperties", 
  "properties": {
    "servers": {
      "items": {
        "$ref": "HostnameOrIPv4Address
      }, 
      "required": true, 
      "title": "NTP servers", 
      "type": "array"
    }, 
    "start_on_boot": {
      "default": true, 
      "required": false, 
      "title": "Start NTP service when system boots", 
      "type": "boolean"
    }
  }, 
  "title": "NTP Service properties", 
  "type": "object"
}

ObjectRolePermissionGroup (type)

{
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "ObjectRolePermissionGroup", 
  "module_id": "PolicyAuthz", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "inheritance_disabled": {
      "default": false, 
      "required": false, 
      "title": "Does children of this object inherit this rule", 
      "type": "boolean"
    }, 
    "operation": {
      "enum": [
        "crud", 
        "read", 
        "execute", 
        "none"
      ], 
      "required": false, 
      "title": "Allowed operation", 
      "type": "string"
    }, 
    "path_prefix": {
      "required": true, 
      "title": "Path prefix", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "role_name": {
      "required": true, 
      "title": "Role name", 
      "type": "string"
    }, 
    "rule_disabled": {
      "default": false, 
      "required": false, 
      "title": "Is rule disabled or not", 
      "type": "boolean"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "RBAC Objects qualifier", 
  "type": "object"
}

ObjectRolePermissionGroupListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "ObjectRolePermissionGroupListRequestParameters", 
  "module_id": "PolicyAuthz", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "inheritance_disabled": {
      "default": false, 
      "required": false, 
      "title": "Does children of this object inherit this rule", 
      "type": "boolean"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "path_prefix": {
      "required": false, 
      "title": "Path prefix", 
      "type": "string"
    }, 
    "role_name": {
      "required": false, 
      "title": "Role name", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "RBAC Objects qualifier", 
  "type": "object"
}

ObjectRolePermissionGroupListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ObjectRolePermissionGroupListResult", 
  "module_id": "PolicyAuthz", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "ObjectRolePermissionGroup
      }, 
      "required": true, 
      "title": "ObjectRolePermissionGroup list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged collection of RBAC Objects", 
  "type": "object"
}

OnboardingAttribute (type)

{
  "description": "Generic config onboarding attributes in form attribute name and its corresponding values.", 
  "id": "OnboardingAttribute", 
  "module_id": "GmConfigOnboarding", 
  "properties": {
    "name": {
      "readonly": true, 
      "required": true, 
      "title": "Attribute name", 
      "type": "string"
    }, 
    "value": {
      "readonly": true, 
      "required": false, 
      "title": "Attribute value", 
      "type": "string"
    }, 
    "value_type": {
      "default": "STRING", 
      "enum": [
        "STRING", 
        "INTEGER", 
        "BOOLEAN"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Attribute Type", 
      "type": "string"
    }
  }, 
  "title": "Config Onboarding Attributes", 
  "type": "object"
}

OnboardingCompatibilityStatus (type)

{
  "enum": [
    "COMPATIBLE", 
    "INCOMPATIBLE"
  ], 
  "help": "Configuration onboarding compatibility status represents onboarding site's\nconfiguration compatibility on Global manager in order to keep overall\nsecurity posture unchanged.\nCOMPATIBLE     - Onboarding site configuration is compatible with Global\n                 manager configuration and will not impact security posture\n                 upon configuration onboarding.\nINCOMPATIBLE   - Onboarding site configuration is not compatible with Global\n                 manager configuration and will impact security posture upon\n                 configuration onboarding.\n", 
  "id": "OnboardingCompatibilityStatus", 
  "module_id": "GmConfigOnboarding", 
  "title": "Onboarding Compatibility Status", 
  "type": "string"
}

OnboardingConflictStatus (type)

{
  "enum": [
    "NO_CONFLICTS", 
    "CONFLICT_DETECTED"
  ], 
  "help": "Configuration onboarding conflict status on Global manager. Global manager\ncan have below status based on conflict in path between site configuration\nand global configuration.\nNO_CONFLICTS        - No conflicts found between site configuration and\n                      global configuration.\nCONFLICT_DETECTED   - One or more conflicts found between site configuration\n                      and global configuration\n", 
  "id": "OnboardingConflictStatus", 
  "module_id": "GmConfigOnboarding", 
  "title": "Onboarding Conflict Status", 
  "type": "string"
}

OnboardingFeatureInfo (type)

{
  "description": "Feature information currently under process or refered to.", 
  "id": "OnboardingFeatureInfo", 
  "module_id": "GmConfigOnboarding", 
  "properties": {
    "name": {
      "readonly": true, 
      "required": false, 
      "title": "Feature Name", 
      "type": "string"
    }, 
    "path": {
      "readonly": true, 
      "required": false, 
      "title": "Resource Path", 
      "type": "string"
    }, 
    "resource_type": {
      "readonly": true, 
      "required": false, 
      "title": "Resource Type", 
      "type": "string"
    }
  }, 
  "title": "Onboarding Feature Information", 
  "type": "object"
}

OnboardingStage (type)

{
  "description": "Represents intermediate on-boarding stages on global manager or corresponding site manager.", 
  "enum": [
    "LM_MIGRATION", 
    "LM_SYNCHRONIZATION", 
    "GM_PERSISTENCE", 
    "GM_TRANSFORMATION", 
    "GM_PROCESSING_DONE", 
    "GM_ROLLBACK", 
    "GM_ROLLBACK_DONE"
  ], 
  "id": "OnboardingStage", 
  "module_id": "GmConfigOnboarding", 
  "title": "Config onboarding stage", 
  "type": "string"
}

OnboardingStatus (type)

{
  "enum": [
    "ALLOWED", 
    "BLOCKED_FEATURE_CHECK", 
    "BLOCKED_CONFIG_CONFLICT_CHECK", 
    "BLOCKED_SITE_RESTORE_PENDING", 
    "BLOCKED_FULLSYNC_PENDING", 
    "BLOCKED_USER_REJECT", 
    "BLOCKED_SITE_NOT_REACHABLE", 
    "CONTINUE_RESOLUTION_NEEDED", 
    "IN_PROGRESS", 
    "FAILED_GM_ROLLBACK_IN_PROGRESS", 
    "SUCCESS"
  ], 
  "help": "Configuration onboarding status on Global manager. Currently Global manager\nallows below state transitions.\nALLOWED                         - Site onboarding is allowed for given\n                                  site. This is initial state to begin site\n                                  onboarding.\nBLOCKED_FEATURE_CHECK           - Site onboarding cannot proceed due to\n                                  supported feature mismatch against Global\n                                  manager.\nBLOCKED_CONFIG_CONFLICT_CHECK   - Site onboarding cannot proceed due to\n                                  conflicts in onboarding configuration.\nBLOCKED_SITE_RESTORE_PENDING    - Site onboarding cannot proceed due to\n                                  pending restore operation on site.\nBLOCKED_FULLSYNC_PENDING        - Site onboarding cannot proceed due to\n                                  pending infra state sync to the site.\nBLOCKED_USER_REJECT             - Site onboarding cannot proceed as per\n                                  user preferences.\nBLOCKED_SITE_NOT_REACHABLE      - Onboarding site is not reachable.\nCONTINUE_RESOLUTION_NEEDED      - Site onboarding is allowed to proceed but\n                                  conflict resolution is needed to start\n                                  configuration onboarding successfully.\nIN_PROGRESS                     - Site onboarding process is in progress.\nFAILED_GM_ROLLBACK_IN_PROGRESS  - Site onboarding process has failed and\n                                  rollback operation on gloabl manager is\n                                  in progress\nSUCCESS                         - Site onboarding process has successfully\n                                  completed.\n", 
  "id": "OnboardingStatus", 
  "module_id": "GmConfigOnboarding", 
  "title": "Onboarding Status", 
  "type": "string"
}

OpenLdapIdentitySource (type)

{
  "description": "An identity source service that runs OpenLDAP. The service allows selected user accounts defined in OpenLDAP to log into and access NSX-T.", 
  "extends": {
    "$ref": "LdapIdentitySource
  }, 
  "id": "OpenLdapIdentitySource", 
  "module_id": "LdapIdentitySources", 
  "polymorphic-type-descriptor": {
    "type-identifier": "OpenLdapIdentitySource"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "alternative_domain_names": {
      "description": "After parsing the \"user@domain\", the domain portion is used to select the LDAP identity source to use. Additional domains listed here will also be directed to this LDAP identity source. In Active Directory these are sometimes referred to as Alternative UPN Suffixes.", 
      "items": {
        "type": "string"
      }, 
      "title": "Additional domains to be directed to this identity source", 
      "type": "array"
    }, 
    "base_dn": {
      "description": "The subtree of the LDAP identity source to search when locating users and groups.", 
      "required": true, 
      "title": "DN of subtree for user and group searches", 
      "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"
    }, 
    "domain_name": {
      "description": "The name of the authentication domain. When users log into NSX using an identity of the form \"user@domain\", NSX uses the domain portion to determine which LDAP identity source to use.", 
      "required": true, 
      "title": "Authentication domain name", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ldap_servers": {
      "description": "The list of LDAP servers that provide LDAP service for this identity source. Currently, only one LDAP server is supported.", 
      "items": {
        "$ref": "IdentitySourceLdapServer
      }, 
      "maxItems": 1, 
      "title": "LDAP servers for this identity source", 
      "type": "array"
    }, 
    "resource_type": {
      "enum": [
        "ActiveDirectoryIdentitySource", 
        "OpenLdapIdentitySource"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "An OpenLDAP identity source service", 
  "type": "object"
}

OverriddenResource (type)

{
  "additionalProperties": false, 
  "description": "Represents which federated global resources have been overrriden on a specific Site.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "OverriddenResource", 
  "module_id": "PolicyOverrides", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "intent_path": {
      "description": "Policy resource path of the overridden resource.", 
      "readonly": true, 
      "title": "Policy resource path of the overridden resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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"
    }, 
    "site_path": {
      "description": "Site path to the specific site that has overridden the global resource.", 
      "readonly": true, 
      "title": "Site path", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Represents overridden resource information for federated entity.", 
  "type": "object"
}

OverriddenResourceListResult (type)

{
  "additionalProperties": false, 
  "description": "Paged Collection of OverriddenResource.", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "OverriddenResourceListResult", 
  "module_id": "PolicyOverrides", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "OverriddenResource list results.", 
      "items": {
        "$ref": "OverriddenResource
      }, 
      "required": true, 
      "title": "OverriddenResource list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of OverriddenResource", 
  "type": "object"
}

OverrideDeleteRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "DeleteRequestParameters
  }, 
  "id": "OverrideDeleteRequestParameters", 
  "module_id": "Policy", 
  "properties": {
    "force": {
      "default": false, 
      "description": "If true, deleting the resource succeeds even if it is being referred as a resource reference.", 
      "title": "Force delete the resource even if it is being used somewhere\n", 
      "type": "boolean"
    }, 
    "override": {
      "default": false, 
      "description": "If true, the overridden object can be deleted locally.  This will restore the global resource as the intended configuration for this site.", 
      "required": false, 
      "title": "Delete the locally overriden global object", 
      "type": "boolean"
    }
  }, 
  "title": "Override delete request parameters", 
  "type": "object"
}

OverrideListRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "Parameter to filter overridden resource list by intent path or site path or both.", 
  "id": "OverrideListRequestParameters", 
  "module_id": "PolicyOverrides", 
  "properties": {
    "intent_path": {
      "required": false, 
      "title": "Global resource path", 
      "type": "string"
    }, 
    "site_path": {
      "required": false, 
      "title": "Site path", 
      "type": "string"
    }
  }, 
  "title": "Override list request parameters", 
  "type": "object"
}

OverrideRequestParameters (type)

{
  "additionalProperties": false, 
  "id": "OverrideRequestParameters", 
  "module_id": "Policy", 
  "properties": {
    "override": {
      "default": false, 
      "description": "If true, the global resource can be over written locally. This means that there will be a local only resource in place of the global resource that can reflect local specific settings and values. The global object will continue to exist but will not be used for any configuration until this local object is removed. When the object is overridden the Global resource continues to exist unmodified, while the overridden object is created with all of the user specified values.  The Global resource may be updated in the background, however, the overridden object may only be updated by the user. Once the user removes the overridden copy, the Global resource will then resume being used in the configuration.", 
      "required": false, 
      "title": "Locally override the global object", 
      "type": "boolean"
    }
  }, 
  "title": "Override request parameters", 
  "type": "object"
}

PackageLoggingLevels (type)

{
  "additionalProperties": false, 
  "id": "PackageLoggingLevels", 
  "properties": {
    "logging_level": {
      "enum": [
        "OFF", 
        "FATAL", 
        "ERROR", 
        "WARN", 
        "INFO", 
        "DEBUG", 
        "TRACE"
      ], 
      "title": "Logging levels per package", 
      "type": "string"
    }, 
    "package_name": {
      "title": "Package name", 
      "type": "string"
    }
  }, 
  "type": "object"
}

PacketAddressClassifier (type)

{
  "description": "A packet is classified to have an address binding, if its address configuration matches with all user specified properties.", 
  "id": "PacketAddressClassifier", 
  "module_id": "Switching", 
  "properties": {
    "ip_address": {
      "$ref": "IPElement, 
      "required": false, 
      "title": "A single IP address or a subnet, e.g. x.x.x.x or x.x.x.x/y"
    }, 
    "mac_address": {
      "$ref": "MACAddress, 
      "required": false, 
      "title": "A single MAC address"
    }, 
    "vlan": {
      "$ref": "VlanID, 
      "required": false
    }
  }, 
  "title": "Address classifications for a packet", 
  "type": "object"
}

PacketData (type)

{
  "abstract": true, 
  "id": "PacketData", 
  "module_id": "Traceflow", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "resource_type"
  }, 
  "properties": {
    "frame_size": {
      "default": 128, 
      "description": "If the requested frame_size is too small (given the payload and traceflow metadata requirement of 16 bytes), the traceflow request will fail with an appropriate message.  The frame will be zero padded to the requested size.", 
      "maximum": 1000, 
      "minimum": 60, 
      "required": false, 
      "title": "Requested total size of the (logical) packet in bytes", 
      "type": "integer"
    }, 
    "resource_type": {
      "default": "FieldsPacketData", 
      "enum": [
        "BinaryPacketData", 
        "FieldsPacketData"
      ], 
      "required": true, 
      "title": "Packet configuration", 
      "type": "string"
    }, 
    "routed": {
      "required": false, 
      "title": "A flag, when set true, indicates that the traceflow packet is of L3 routing.", 
      "type": "boolean"
    }, 
    "transport_type": {
      "default": "UNICAST", 
      "enum": [
        "BROADCAST", 
        "UNICAST", 
        "MULTICAST", 
        "UNKNOWN"
      ], 
      "required": false, 
      "title": "transport type of the traceflow packet", 
      "type": "string"
    }
  }, 
  "type": "object"
}

PacketTypeAndCounter (type)

{
  "id": "PacketTypeAndCounter", 
  "module_id": "AggSvcL2Types", 
  "properties": {
    "counter": {
      "required": true, 
      "title": "The number of packets.", 
      "type": "integer"
    }, 
    "packet_type": {
      "required": true, 
      "title": "The type of the packets", 
      "type": "string"
    }
  }, 
  "type": "object"
}

PacketsDroppedBySecurity (type)

{
  "id": "PacketsDroppedBySecurity", 
  "module_id": "AggSvcL2Types", 
  "properties": {
    "bpdu_filter_dropped": {
      "required": false, 
      "title": "The number of packets dropped by \"BPDU filter\".", 
      "type": "integer"
    }, 
    "dhcp_client_dropped_ipv4": {
      "required": false, 
      "title": "The number of IPv4 packets dropped by \"DHCP client block\".", 
      "type": "integer"
    }, 
    "dhcp_client_dropped_ipv6": {
      "required": false, 
      "title": "The number of IPv6 packets dropped by \"DHCP client block\".", 
      "type": "integer"
    }, 
    "dhcp_server_dropped_ipv4": {
      "required": false, 
      "title": "The number of IPv4 packets dropped by \"DHCP server block\".", 
      "type": "integer"
    }, 
    "dhcp_server_dropped_ipv6": {
      "required": false, 
      "title": "The number of IPv6 packets dropped by \"DHCP server block\".", 
      "type": "integer"
    }, 
    "spoof_guard_dropped": {
      "items": {
        "$ref": "PacketTypeAndCounter
      }, 
      "required": false, 
      "title": "The packets dropped by \"Spoof Guard\"; supported packet types are IPv4, IPv6, ARP, ND, non-IP.", 
      "type": "array"
    }
  }, 
  "type": "object"
}

PartialPatchConfig (type)

{
  "additionalProperties": false, 
  "description": "This object allows enabling or disabling of partial patch functionality. Enabling partial patch allows patching of a subset of the fields of any object. After enabling partial patching, any object payload provided will be merged with the existing object payload. Note that while all mandatory fields are expected to be provided during the creation of any object, enabling partial patch will allow patching of existing objects with a subset of mandatory fields.", 
  "id": "PartialPatchConfig", 
  "module_id": "PolicySystemConfig", 
  "properties": {
    "enable_partial_patch": {
      "description": "boolean value used to enable/disable partial patch", 
      "required": true, 
      "title": "This object will contain the partial patch configuration.", 
      "type": "boolean"
    }
  }, 
  "title": "Contains configuration for Partial patch.", 
  "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"
}

PatchResources (type)

{
  "additionalProperties": false, 
  "description": "Patch Resources is an action to create/patch resources in response to an event.", 
  "extends": {
    "$ref": "Action
  }, 
  "id": "PatchResources", 
  "module_id": "PolicyReaction", 
  "polymorphic-type-descriptor": {
    "type-identifier": "PatchResources"
  }, 
  "properties": {
    "body": {
      "description": "Patch body representing a Hierarchical Patch payload. The resources included in the body are patched replacing the injections' keys with their actual values.", 
      "required": true, 
      "title": "Body", 
      "type": "object"
    }, 
    "injections": {
      "description": "Injections holding keys (variables) and their corresponding values.", 
      "items": {
        "$ref": "Injection
      }, 
      "minItems": 1, 
      "title": "Injections", 
      "type": "array"
    }, 
    "resource_type": {
      "description": "Reaction Action resource type.", 
      "enum": [
        "PatchResources", 
        "SetFields"
      ], 
      "required": true, 
      "title": "Resource Type", 
      "type": "string"
    }
  }, 
  "title": "Patch Resources", 
  "type": "object"
}

PathExpression (type)

{
  "additionalProperties": false, 
  "description": "Represents policy path expressions in the form of an array, to support addition of objects like groups, segments and policy logical ports in a group.", 
  "extends": {
    "$ref": "Expression
  }, 
  "id": "PathExpression", 
  "module_id": "Policy", 
  "polymorphic-type-descriptor": {
    "type-identifier": "PathExpression"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "paths": {
      "description": "This array can consist of one or more policy paths. Only policy paths of groups, segments and policy logical ports are allowed.", 
      "items": {
        "type": "string"
      }, 
      "minItems": 1, 
      "required": true, 
      "title": "Array of policy paths", 
      "type": "array"
    }, 
    "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", 
        "ExternalIDExpression", 
        "PathExpression", 
        "IdentityGroupExpression"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Path expression node", 
  "type": "object"
}

PathPermissionGroup (type)

{
  "additionalProperties": false, 
  "id": "PathPermissionGroup", 
  "module_id": "PolicyAuthz", 
  "properties": {
    "object_path": {
      "required": true, 
      "title": "Full Object Path", 
      "type": "string"
    }, 
    "operation": {
      "enum": [
        "crud", 
        "read", 
        "execute", 
        "none"
      ], 
      "required": true, 
      "title": "Allowed operation", 
      "type": "string"
    }
  }, 
  "title": "RBAC Objects qualifier", 
  "type": "object"
}

PeerCertificateChain (type)

{
  "additionalProperties": false, 
  "description": "The certificate chain presented by a remote TLS service.", 
  "id": "PeerCertificateChain", 
  "module_id": "CertificateManager", 
  "properties": {
    "details": {
      "description": "List of X509Certificates.", 
      "items": {
        "$ref": "X509Certificate
      }, 
      "readonly": true, 
      "required": false, 
      "type": "array"
    }, 
    "pem_encoded": {
      "description": "PEM encoded certificate data.", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }
  }, 
  "title": "A peer's certificate chain", 
  "type": "object"
}

PendingChangesInfoNsxT (type)

{
  "additionalProperties": false, 
  "description": "Information about recent changes, if any, that are not reflected in the Enforced Realized Status.", 
  "id": "PendingChangesInfoNsxT", 
  "module_id": "PolicyRealizationStatus", 
  "properties": {
    "pending_changes_flag": {
      "description": "Flag describing whether there are any pending changes that are not reflected in the status.", 
      "readonly": true, 
      "title": "Pending Changes Flag", 
      "type": "boolean"
    }
  }, 
  "title": "NSX-T Pending Change Info", 
  "type": "object"
}

PerStepRestoreStatus (type)

{
  "id": "PerStepRestoreStatus", 
  "module_id": "ClusterRestore", 
  "properties": {
    "description": {
      "readonly": true, 
      "required": true, 
      "title": "A description of the restore status", 
      "type": "string"
    }, 
    "value": {
      "enum": [
        "INITIAL", 
        "RUNNING", 
        "SUSPENDED_BY_USER", 
        "SUSPENDED_FOR_USER_ACTION", 
        "FAILED", 
        "SUCCESS"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Per step restore status value", 
      "type": "string"
    }
  }, 
  "title": "Restore step status", 
  "type": "object"
}

PlainFilterData (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "LiveTraceFilterData
  }, 
  "id": "PlainFilterData", 
  "module_id": "LiveTrace", 
  "polymorphic-type-descriptor": {
    "type-identifier": "PlainFilterData"
  }, 
  "properties": {
    "basic_filter": {
      "required": false, 
      "title": "Basic RCF rule for packet filter", 
      "type": "string"
    }, 
    "extend_filter": {
      "required": false, 
      "title": "Extended RCF rule for packet filter", 
      "type": "string"
    }, 
    "resource_type": {
      "default": "FieldsFilterData", 
      "enum": [
        "FieldsFilterData", 
        "PlainFilterData"
      ], 
      "required": true, 
      "title": "Filter type", 
      "type": "string"
    }
  }, 
  "type": "object"
}

PointDefinition (type)

{
  "additionalProperties": false, 
  "description": "Defines the point of a graph.", 
  "id": "PointDefinition", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "properties": {
    "drilldown_id": {
      "description": "Id of drilldown widget, if any. Id should be a valid id of an existing widget. A widget is considered as drilldown widget when it is associated with any other widget and provides more detailed information about any data item from the parent widget.", 
      "title": "Id of drilldown widget", 
      "type": "string"
    }, 
    "field": {
      "description": "An expression that represents the points of the graph", 
      "required": true, 
      "title": "Expression for points of the graph", 
      "type": "string"
    }, 
    "navigation": {
      "description": "Hyperlink of the specified UI page that provides details.", 
      "maxLength": 1024, 
      "title": "Navigation to a specified UI page", 
      "type": "string"
    }, 
    "tooltip": {
      "description": "Multi-line text to be shown on tooltip while hovering over the point of a graph.", 
      "items": {
        "$ref": "Tooltip
      }, 
      "minItems": 0, 
      "title": "Multi-line tooltip", 
      "type": "array"
    }, 
    "x_value": {
      "description": "Represents the variable for the X value of points that are plotted on the graph.", 
      "required": true, 
      "title": "Variable chosen for X value of the point of the graph", 
      "type": "string"
    }, 
    "y_value": {
      "description": "Represents the variable for the Y value of points that are plotted on the graph.", 
      "required": true, 
      "title": "Variable chosen for Y value of the point of the graph", 
      "type": "string"
    }
  }, 
  "title": "Definition of a point of graph", 
  "type": "object"
}

Policy (type)

{
  "additionalProperties": false, 
  "description": "Ordered list of Rules. This object is created by default along with the Domain.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "Policy", 
  "module_id": "Policy", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "category": {
      "description": "- Distributed Firewall - Policy framework provides five pre-defined categories for classifying a security policy. They are \"Ethernet\",\"Emergency\", \"Infrastructure\" \"Environment\" and \"Application\". There is a pre-determined order in which the policy framework manages the priority of these security policies. Ethernet category is for supporting layer 2 firewall rules. The other four categories are applicable for layer 3 rules. Amongst them, the Emergency category has the highest priority followed by Infrastructure, Environment and then Application rules. Administrator can choose to categorize a security policy into the above categories or can choose to leave it empty. If empty it will have the least precedence w.r.t the above four categories. - Edge Firewall - Policy Framework for Edge Firewall provides six pre-defined categories \"Emergency\", \"SystemRules\", \"SharedPreRules\", \"LocalGatewayRules\", \"AutoServiceRules\" and \"Default\", in order of priority of rules. All categories are allowed for Gatetway Policies that belong to 'default' Domain. However, for user created domains, category is restricted to \"SharedPreRules\" or \"LocalGatewayRules\" only. Also, the users can add/modify/delete rules from only the \"SharedPreRules\" and \"LocalGatewayRules\" categories. If user doesn't specify the category then defaulted to \"Rules\". System generated category is used by NSX created rules, for example BFD rules. Autoplumbed category used by NSX verticals to autoplumb data path rules. Finally, \"Default\" category is the placeholder default rules with lowest in the order of priority.", 
      "required": false, 
      "title": "A way to classify a security policy, if needed.", 
      "type": "string"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "comments": {
      "description": "Comments for security policy lock/unlock.", 
      "readonly": false, 
      "required": false, 
      "title": "SecurityPolicy lock/unlock comments", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "internal_sequence_number": {
      "description": "This field is to indicate the internal sequence number of a policy with respect to the policies across categories.", 
      "readonly": true, 
      "title": "Internal sequence number", 
      "type": "int"
    }, 
    "is_default": {
      "description": "A flag to indicate whether policy is a default policy.", 
      "readonly": true, 
      "required": false, 
      "title": "Default policy flag", 
      "type": "boolean"
    }, 
    "lock_modified_by": {
      "description": "ID of the user who last modified the lock for the secruity policy.", 
      "readonly": true, 
      "required": false, 
      "title": "User who locked the security policy", 
      "type": "string"
    }, 
    "lock_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "description": "SecurityPolicy locked/unlocked time in epoch milliseconds.", 
      "readonly": true, 
      "required": false, 
      "title": "SecuirtyPolicy locked/unlocked time"
    }, 
    "locked": {
      "default": false, 
      "description": "Indicates whether a security policy should be locked. If the security policy is locked by a user, then no other user would be able to modify this security policy. Once the user releases the lock, other users can update this security policy.", 
      "required": false, 
      "title": "Lock a security policy", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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"
    }, 
    "rule_count": {
      "description": "The count of rules in the policy.", 
      "readonly": true, 
      "title": "Rule count", 
      "type": "int"
    }, 
    "scheduler_path": {
      "description": "Provides a mechanism to apply the rules in this policy for a specified time duration.", 
      "readonly": false, 
      "required": false, 
      "title": "Path to the scheduler for time based scheduling", 
      "type": "string"
    }, 
    "scope": {
      "description": "The list of group paths where the rules in this policy will get applied. This scope will take precedence over rule level scope. Supported only for security and redirection policies. In case of RedirectionPolicy, it is expected only when the policy is NS and redirecting to service chain.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 128, 
      "required": false, 
      "type": "array"
    }, 
    "sequence_number": {
      "description": "This field is used to resolve conflicts between security policies across domains. In order to change the sequence number of a policy one can fire a POST request on the policy entity with a query parameter action=revise The sequence number field will reflect the value of the computed sequence number upon execution of the above mentioned POST request. For scenarios where the administrator is using a template to update several security policies, the only way to set the sequence number is to explicitly specify the sequence number for each security policy. If no sequence number is specified in the payload, a value of 0 is assigned by default. If there are multiple policies with the same sequence number then their order is not deterministic. If a specific order of policies is desired, then one has to specify unique sequence numbers or use the POST request on the policy entity with a query parameter action=revise to let the framework assign a sequence number", 
      "minimum": 0, 
      "title": "Sequence number to resolve conflicts across Domains", 
      "type": "int"
    }, 
    "stateful": {
      "description": "Stateful or Stateless nature of security policy is enforced on all rules in this security policy. When it is stateful, the state of the network connects are tracked and a stateful packet inspection is performed. Layer3 security policies can be stateful or stateless. By default, they are stateful. Layer2 security policies can only be stateless.", 
      "readonly": false, 
      "required": false, 
      "title": "Stateful nature of the entries within this security policy.", 
      "type": "boolean"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "tcp_strict": {
      "description": "Ensures that a 3 way TCP handshake is done before the data packets are sent. tcp_strict=true is supported only for stateful security policies. If the tcp_strict flag is not specified and the security policy is stateful, then tcp_strict will be set to true.", 
      "readonly": false, 
      "required": false, 
      "title": "Enforce strict tcp handshake before allowing data packets", 
      "type": "boolean"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Contains ordered list of Rules", 
  "type": "object"
}

PolicyAlarmResource (type)

{
  "description": "Alarm base class of realized policy object", 
  "extends": {
    "$ref": "PolicyResource
  }, 
  "id": "PolicyAlarmResource", 
  "module_id": "PolicyRealizedState", 
  "polymorphic-type-descriptor": {
    "type-identifier": "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: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "error_details": {
      "$ref": "PolicyApiError, 
      "required": false, 
      "title": "Detailed information about errors from an API call made to the\nenforcement point, if any.\n"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "message": {
      "required": false, 
      "title": "error message to describe the issue", 
      "type": "string"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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"
    }, 
    "source_reference": {
      "required": false, 
      "title": "path of the object on which alarm is created", 
      "type": "string"
    }, 
    "source_site_id": {
      "description": "This field will refer to the source site on which the alarm is generated. This field is populated by GM, when it receives corresponding notification from LM.", 
      "readonly": true, 
      "required": false, 
      "title": "source site(LM) id.", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Alarm base class of realized policy object", 
  "type": "object"
}

PolicyAlarmResourceListRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "PolicyAlarmResource list request parameters", 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "PolicyAlarmResourceListRequestParameters", 
  "module_id": "PolicyRealizedState", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "PolicyAlarmResource list request parameters", 
  "type": "object"
}

PolicyAlarmResourceListResult (type)

{
  "additionalProperties": false, 
  "description": "PolicyAlarmResource list result", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "PolicyAlarmResourceListResult", 
  "module_id": "PolicyRealizedState", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "List of alarm resources", 
      "items": {
        "$ref": "PolicyAlarmResource
      }, 
      "required": false, 
      "title": "Paged Collection of PolicyAlarmResources", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "PolicyAlarmResource list result", 
  "type": "object"
}

PolicyApiError (type)

{
  "extends": {
    "$ref": "PolicyRelatedApiError
  }, 
  "id": "PolicyApiError", 
  "module_id": "PolicyRealizedState", 
  "properties": {
    "details": {
      "title": "Further details about the error", 
      "type": "string"
    }, 
    "error_code": {
      "title": "A numeric error code", 
      "type": "integer"
    }, 
    "error_data": {
      "title": "Additional data about the error", 
      "type": "object"
    }, 
    "error_message": {
      "title": "A description of the error", 
      "type": "string"
    }, 
    "module_name": {
      "title": "The module name where the error occurred", 
      "type": "string"
    }, 
    "related_errors": {
      "items": {
        "$ref": "PolicyRelatedApiError
      }, 
      "title": "Other errors related to this error", 
      "type": "array"
    }
  }, 
  "title": "Detailed information about an API Error", 
  "type": "object"
}

PolicyArpProxyEntry (type)

{
  "additionalProperties": false, 
  "id": "PolicyArpProxyEntry", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "arp_proxy_ip": {
      "description": "ARP proxy information for a service with ip.", 
      "items": {
        "$ref": "IPAddress
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Array of ARP proxy service address", 
      "type": "array"
    }, 
    "service_id": {
      "description": "Identifier of connected service on port.", 
      "readonly": true, 
      "required": false, 
      "title": "Service type id", 
      "type": "string"
    }
  }, 
  "type": "object"
}

PolicyArpProxyTableListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "PolicyArpProxyTableListResult", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "InterfaceArpProxy
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Paginated list of Gateway interface ARP proxy tables", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

PolicyAttributes (type)

{
  "additionalProperties": false, 
  "id": "PolicyAttributes", 
  "module_id": "PolicyContextProfile", 
  "properties": {
    "attribute_source": {
      "default": "SYSTEM", 
      "enum": [
        "SYSTEM", 
        "CUSTOM"
      ], 
      "required": false, 
      "title": "Source of attribute value i.e whether system defined or custom value", 
      "type": "string"
    }, 
    "datatype": {
      "enum": [
        "STRING"
      ], 
      "required": true, 
      "title": "Datatype for attribute", 
      "type": "string"
    }, 
    "description": {
      "required": false, 
      "title": "Description for attribute value", 
      "type": "string"
    }, 
    "isALGType": {
      "description": "Describes whether the APP_ID value is ALG type or not.", 
      "required": false, 
      "title": "Is the value ALG type", 
      "type": "boolean"
    }, 
    "key": {
      "description": "URL_Reputation is currently not available. Please do not use it in Attribute Key while creating context profile", 
      "enum": [
        "APP_ID", 
        "DOMAIN_NAME", 
        "URL_CATEGORY", 
        "URL_REPUTATION"
      ], 
      "required": true, 
      "title": "Key for attribute", 
      "type": "string"
    }, 
    "metadata": {
      "description": "This is optional part that can hold additional data about the attribute key/values. Example - For URL CATEGORY key , it specified super category for url category value. This is generic array and can hold multiple meta information about key/values in future", 
      "items": {
        "$ref": "ContextProfileAttributesMetadata
      }, 
      "required": false, 
      "title": "Provide additional meta information about key/values", 
      "type": "array"
    }, 
    "sub_attributes": {
      "items": {
        "$ref": "PolicySubAttributes
      }, 
      "required": false, 
      "title": "Reference to sub attributes for the attribute", 
      "type": "array"
    }, 
    "value": {
      "description": "Multiple attribute values can be specified as elements of array.", 
      "items": {
        "type": "string"
      }, 
      "minItems": 1, 
      "required": true, 
      "title": "Value for attribute key", 
      "type": "array", 
      "uniqueItems": true
    }
  }, 
  "title": "Policy Attributes data holder", 
  "type": "object"
}

PolicyBasedIPSecVpnSession (type)

{
  "additionalProperties": false, 
  "description": "A Policy Based VPN requires to define protect rules that match local and peer subnets. IPSec security associations is negotiated for each pair of local and peer subnet.", 
  "extends": {
    "$ref": "IPSecVpnSession
  }, 
  "id": "PolicyBasedIPSecVpnSession", 
  "module_id": "PolicyIPSecVpn", 
  "polymorphic-type-descriptor": {
    "type-identifier": "PolicyBasedIPSecVpnSession"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "authentication_mode": {
      "default": "PSK", 
      "description": "Peer authentication mode. PSK - In this mode a secret key shared between local and peer sites is to be used for authentication. The secret key can be a string with a maximum length of 128 characters. CERTIFICATE - In this mode a certificate defined at the global level is to be used for authentication.", 
      "enum": [
        "PSK", 
        "CERTIFICATE"
      ], 
      "title": "Authentication Mode", 
      "type": "string"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "compliance_suite": {
      "description": "Compliance suite.", 
      "enum": [
        "CNSA", 
        "SUITE_B_GCM_128", 
        "SUITE_B_GCM_256", 
        "PRIME", 
        "FOUNDATION", 
        "FIPS", 
        "NONE"
      ], 
      "title": "Compliance suite", 
      "type": "string"
    }, 
    "connection_initiation_mode": {
      "default": "INITIATOR", 
      "description": "Connection initiation mode used by local endpoint to establish ike connection with peer site. INITIATOR - In this mode local endpoint initiates tunnel setup and will also respond to incoming tunnel setup requests from peer gateway. RESPOND_ONLY - In this mode, local endpoint shall only respond to incoming tunnel setup requests. It shall not initiate the tunnel setup. ON_DEMAND - In this mode local endpoint will initiate tunnel creation once first packet matching the policy rule is received and will also respond to incoming initiation request.", 
      "enum": [
        "INITIATOR", 
        "RESPOND_ONLY", 
        "ON_DEMAND"
      ], 
      "title": "Connection initiation mode", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "dpd_profile_path": {
      "description": "Policy path referencing Dead Peer Detection (DPD) profile. Default is set to system default profile.", 
      "title": "Dead peer detection (DPD) profile path", 
      "type": "string"
    }, 
    "enabled": {
      "default": true, 
      "description": "Enable/Disable IPSec VPN session.", 
      "title": "Enable/Disable IPSec VPN session", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ike_profile_path": {
      "description": "Policy path referencing IKE profile to be used. Default is set according to system default profile.", 
      "title": "Internet key exchange (IKE) profile path", 
      "type": "string"
    }, 
    "local_endpoint_path": {
      "description": "Policy path referencing Local endpoint.", 
      "required": true, 
      "title": "Local endpoint path", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "peer_address": {
      "description": "Public IPV4 address of the remote device terminating the VPN connection.", 
      "required": true, 
      "title": "IPV4 address of peer endpoint on remote site", 
      "type": "string"
    }, 
    "peer_id": {
      "description": "Peer ID to uniquely identify the peer site. The peer ID is the public IP address of the remote device terminating the VPN tunnel. When NAT is configured for the peer, enter the private IP address of the peer.", 
      "required": true, 
      "title": "Peer id", 
      "type": "string"
    }, 
    "psk": {
      "description": "IPSec Pre-shared key. Maximum length of this field is 128 characters.", 
      "sensitive": true, 
      "title": "Pre-shared key", 
      "type": "string"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "$ref": "IPSecVpnSessionResourceType, 
      "required": true
    }, 
    "rules": {
      "items": {
        "$ref": "IPSecVpnRule
      }, 
      "minItems": 1, 
      "required": true, 
      "title": "Rules", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "tcp_mss_clamping": {
      "$ref": "TcpMaximumSegmentSizeClamping, 
      "description": "TCP Maximum Segment Size Clamping Direction and Value.", 
      "title": "TCP MSS Clamping"
    }, 
    "tunnel_profile_path": {
      "description": "Policy path referencing Tunnel profile to be used. Default is set to system default profile.", 
      "title": "IPSec tunnel profile path", 
      "type": "string"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Policy based VPN session", 
  "type": "object"
}

PolicyBasedL3VpnSession (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "A Policy-based L3Vpn session is a configuration in which a specific vpn tunnel is referenced in a policy whose action is set as tunnel.", 
  "extends": {
    "$ref": "L3VpnSession
  }, 
  "id": "PolicyBasedL3VpnSession", 
  "module_id": "PolicyL3Vpn", 
  "polymorphic-type-descriptor": {
    "type-identifier": "PolicyBasedL3VpnSession"
  }, 
  "properties": {
    "resource_type": {
      "$ref": "L3VpnSessionResourceType, 
      "required": true
    }, 
    "rules": {
      "description": "L3Vpn rules that are specific to the L3Vpn. Only L3Vpn rules with PROTECT action are supported.", 
      "items": {
        "$ref": "L3VpnRule
      }, 
      "title": "L3Vpn Rules", 
      "type": "array", 
      "uniqueItems": true
    }
  }, 
  "title": "Policy based L3Vpn Session", 
  "type": "object"
}

PolicyBgpNeighborStatus (type)

{
  "id": "PolicyBgpNeighborStatus", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "address_families": {
      "description": "Address families of BGP neighbor", 
      "items": {
        "$ref": "BgpAddressFamily
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Address families of BGP neighbor", 
      "type": "array"
    }, 
    "announced_capabilities": {
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "required": false, 
      "title": "BGP capabilities sent to BGP neighbor.", 
      "type": "array"
    }, 
    "connection_drop_count": {
      "readonly": true, 
      "required": false, 
      "title": "Count of connection drop", 
      "type": "integer"
    }, 
    "connection_state": {
      "enum": [
        "INVALID", 
        "IDLE", 
        "CONNECT", 
        "ACTIVE", 
        "OPEN_SENT", 
        "OPEN_CONFIRM", 
        "ESTABLISHED", 
        "UNKNOWN"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Current state of the BGP session.", 
      "type": "string"
    }, 
    "edge_path": {
      "required": false, 
      "title": "Transport node policy path", 
      "type": "string"
    }, 
    "established_connection_count": {
      "readonly": true, 
      "required": false, 
      "title": "Count of connections established", 
      "type": "integer"
    }, 
    "graceful_restart_mode": {
      "description": "Current state of graceful restart of BGP neighbor. Possible values are - 1. GR_AND_HELPER - Graceful restart with Helper 2. HELPER_ONLY - Helper only 3. DISABLE - Disabled", 
      "readonly": true, 
      "required": false, 
      "title": "Graceful restart mode", 
      "type": "string"
    }, 
    "hold_time": {
      "description": "If a HELLO packet is not seen from BGP Peer withing hold_time then BGP neighbor will be marked as down.", 
      "readonly": true, 
      "required": false, 
      "title": "Time in ms to wait for HELLO from BGP peer.", 
      "type": "integer"
    }, 
    "keep_alive_interval": {
      "readonly": true, 
      "required": false, 
      "title": "Time in ms to wait for HELLO packet from BGP peer", 
      "type": "integer"
    }, 
    "last_update_timestamp": {
      "$ref": "EpochMsTimestamp, 
      "description": "Timestamp when the data was last updated, unset if data source has never updated the data.", 
      "readonly": true, 
      "title": "Timestamp indicating last update time of data"
    }, 
    "local_port": {
      "maximum": 65535, 
      "minimum": 1, 
      "readonly": true, 
      "required": false, 
      "title": "TCP port number of Local BGP connection", 
      "type": "integer"
    }, 
    "messages_received": {
      "readonly": true, 
      "required": false, 
      "title": "Count of messages received from the neighbor", 
      "type": "integer"
    }, 
    "messages_sent": {
      "readonly": true, 
      "required": false, 
      "title": "Count of messages sent to the neighbor", 
      "type": "integer"
    }, 
    "negotiated_capability": {
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "required": false, 
      "title": "BGP capabilities negotiated with BGP neighbor.", 
      "type": "array"
    }, 
    "neighbor_address": {
      "$ref": "IPAddress, 
      "readonly": true, 
      "required": false, 
      "title": "The IP of the BGP neighbor"
    }, 
    "neighbor_router_id": {
      "readonly": true, 
      "required": false, 
      "title": "Router ID of the BGP neighbor.", 
      "type": "string"
    }, 
    "remote_as_number": {
      "readonly": true, 
      "required": false, 
      "title": "AS number of the BGP neighbor", 
      "type": "string"
    }, 
    "remote_port": {
      "maximum": 65535, 
      "minimum": 1, 
      "readonly": true, 
      "required": false, 
      "title": "TCP port number of remote BGP Connection", 
      "type": "integer"
    }, 
    "remote_site": {
      "$ref": "ResourceReference, 
      "description": "Remote site details.", 
      "readonly": true, 
      "title": "Remote site"
    }, 
    "source_address": {
      "$ref": "IPAddress, 
      "readonly": true, 
      "required": false, 
      "title": "The Ip address of logical port"
    }, 
    "tier0_path": {
      "readonly": true, 
      "required": true, 
      "title": "Policy path to Tier0", 
      "type": "string"
    }, 
    "time_since_established": {
      "readonly": true, 
      "required": false, 
      "title": "Time(in seconds) since connection was established.", 
      "type": "integer"
    }, 
    "total_in_prefix_count": {
      "description": "Sum of in prefixes counts across all address families.", 
      "readonly": true, 
      "required": false, 
      "title": "Count of in prefixes", 
      "type": "integer"
    }, 
    "total_out_prefix_count": {
      "description": "Sum of out prefixes counts across all address families.", 
      "readonly": true, 
      "required": false, 
      "title": "Count of out prefixes", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

PolicyBgpNeighborsStatusListResult (type)

{
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "PolicyBgpNeighborsStatusListResult", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "additionalProperties": false, 
      "items": {
        "$ref": "PolicyBgpNeighborStatus
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Status of BGP neighbors of the Tier0", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

PolicyComplianceStatus (type)

{
  "id": "PolicyComplianceStatus", 
  "module_id": "PolicyCompliance", 
  "properties": {
    "last_updated_time": {
      "$ref": "EpochMsTimestamp, 
      "readonly": true, 
      "title": "Timestamp of last update"
    }, 
    "non_compliant_configs": {
      "items": {
        "$ref": "PolicyNonCompliantConfig
      }, 
      "readonly": true, 
      "title": "List of non compliant configuration and impacted services", 
      "type": "array"
    }
  }, 
  "type": "object"
}

PolicyConfigResource (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "description": "Represents an object on the desired state.", 
  "extends": {
    "$ref": "PolicyResource
  }, 
  "id": "PolicyConfigResource", 
  "module_id": "Policy", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Represents an object on the desired state", 
  "type": "object"
}

PolicyContextProfile (type)

{
  "additionalProperties": false, 
  "description": "An entity that encapsulates attributes and sub-attributes of various network services (eg. L7 services, domain name, encryption algorithm) The entity will be consumed in firewall rules and can be added in new tuple called profile in firewall rules. To get a list of supported attributes and sub-attributes fire the following REST API GET https://<policy-mgr>/policy/api/v1/infra/context-profiles/attributes", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "PolicyContextProfile", 
  "module_id": "PolicyContextProfile", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "attributes": {
      "description": "Property containing attributes/sub-attributes for Policy Context Profile.", 
      "items": {
        "$ref": "PolicyAttributes
      }, 
      "required": true, 
      "title": "Array of Policy Context Profile attributes", 
      "type": "array"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Policy Context Profile entity", 
  "type": "object"
}

PolicyContextProfileDeleteRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "OverrideDeleteRequestParameters
  }, 
  "id": "PolicyContextProfileDeleteRequestParameters", 
  "module_id": "PolicyContextProfile", 
  "properties": {
    "force": {
      "default": false, 
      "description": "If true, deleting the resource succeeds even if it is being referred as a resource reference.", 
      "title": "Force delete the resource even if it is being used somewhere\n", 
      "type": "boolean"
    }, 
    "override": {
      "default": false, 
      "description": "If true, the overridden object can be deleted locally.  This will restore the global resource as the intended configuration for this site.", 
      "required": false, 
      "title": "Delete the locally overriden global object", 
      "type": "boolean"
    }
  }, 
  "title": "Policy Context Profile delete request parameters", 
  "type": "object"
}

PolicyContextProfileListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "PolicyContextProfileListRequestParameters", 
  "module_id": "PolicyContextProfile", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Policy Context Profile list request parameters", 
  "type": "object"
}

PolicyContextProfileListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "PolicyContextProfileListResult", 
  "module_id": "PolicyContextProfile", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "PolicyContextProfile
      }, 
      "readonly": true, 
      "title": "Paged collection of PolicyContextProfiles", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "List result of PolicyContextProfiles", 
  "type": "object"
}

PolicyDHGroup (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "Diffie-Hellman groups represent algorithm used to derive shared keys between IPSec VPN initiator and responder over an unsecured network. GROUP2 uses 1024-bit Modular Exponentiation (MODP) group. GROUP5 uses 1536-bit MODP group. GROUP14 uses 2048-bit MODP group. GROUP15 uses 3072-bit MODP group. GROUP16 uses 4096-bit MODP group.", 
  "enum": [
    "GROUP2", 
    "GROUP5", 
    "GROUP14", 
    "GROUP15", 
    "GROUP16"
  ], 
  "id": "PolicyDHGroup", 
  "module_id": "PolicyL3Vpn", 
  "title": "Diffie-Hellman groups", 
  "type": "string"
}

PolicyDnsAnswerPerEnforcementPoint (type)

{
  "abstract": true, 
  "description": "DNS forwarder nslookup answer per enforcement point.", 
  "id": "PolicyDnsAnswerPerEnforcementPoint", 
  "module_id": "PolicyDnsForwarder", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "resource_type"
  }, 
  "properties": {
    "enforcement_point_path": {
      "description": "Policy path referencing the enforcement point from where the DNS forwarder nslookup answer is fetched.", 
      "readonly": true, 
      "title": "Enforcement point path", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "Resource type of the DNS forwarder nslookup answer.", 
      "enum": [
        "NsxTDnsAnswer"
      ], 
      "required": true, 
      "title": "Resource type", 
      "type": "string"
    }
  }, 
  "title": "NSLookup answer per enforcement point", 
  "type": "object"
}

PolicyDnsForwarder (type)

{
  "additionalProperties": false, 
  "description": "Used to configure DNS Forwarder", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "PolicyDnsForwarder", 
  "module_id": "PolicyDnsForwarder", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "conditional_forwarder_zone_paths": {
      "description": "Max of 5 DNS servers can be configured", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 5, 
      "required": false, 
      "title": "Path of conditional DNS zones", 
      "type": "array"
    }, 
    "default_forwarder_zone_path": {
      "description": "This is the zone to which DNS requests are forwarded by default", 
      "required": true, 
      "title": "Path of the default DNS zone.", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "enabled": {
      "default": true, 
      "description": "The flag, which suggests whether the DNS forwarder is enabled or disabled. The default is True.", 
      "title": "DNS forwarder enabled flag", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "listener_ip": {
      "$ref": "IPv4Address, 
      "description": "This is the IP on which the DNS Forwarder listens.", 
      "required": true, 
      "title": "IP on which the DNS Forwarder listens."
    }, 
    "log_level": {
      "default": "INFO", 
      "description": "Set log_level to DISABLED will stop dumping fowarder log.", 
      "enum": [
        "DEBUG", 
        "INFO", 
        "WARNING", 
        "ERROR", 
        "FATAL"
      ], 
      "required": false, 
      "title": "Log level of the dns forwarder", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "DNS Forwarder", 
  "type": "object"
}

PolicyDnsForwarderZone (type)

{
  "additionalProperties": false, 
  "description": "Used to configure zones on DNS Forwarder", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "PolicyDnsForwarderZone", 
  "module_id": "PolicyDnsForwarder", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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"
    }, 
    "dns_domain_names": {
      "description": "List of domain names on which conditional forwarding is based. This field is required if the DNS Zone is being used for a conditional forwarder. This field will also be used for conditional reverse lookup. Example 1, if for one of the zones, one of the entries in the fqdn is example.com, all the DNS requests under the domain example.com will be served by the corresponding upstream DNS server. Example 2, if for one of the zones, one of the entries in the fqdn list is \"13.12.30.in-addr.arpa\", reverse lookup for 30.12.13.0/24 will go to the corresponding DNS server.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "List of domain names", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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"
    }, 
    "source_ip": {
      "$ref": "IPv4Address, 
      "description": "The source IP used by the DNS Forwarder zone.", 
      "required": false, 
      "title": "Source IP used by DNS Forwarder zone"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }, 
    "upstream_servers": {
      "description": "Max of 3 DNS servers can be configured", 
      "items": {
        "$ref": "IPv4Address
      }, 
      "maxItems": 3, 
      "required": true, 
      "title": "DNS servers to which the DNS request needs to be forwarded", 
      "type": "array"
    }
  }, 
  "title": "DNS Forwarder Zone", 
  "type": "object"
}

PolicyDnsForwarderZoneListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "PolicyDnsForwarderZoneListRequestParameters", 
  "module_id": "PolicyDnsForwarder", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "DNS Forwarder Zone list request parameters", 
  "type": "object"
}

PolicyDnsForwarderZoneListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "PolicyDnsForwarderZoneListResult", 
  "module_id": "PolicyDnsForwarder", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "PolicyDnsForwarderZone
      }, 
      "required": true, 
      "title": "Dns Forwarder Zone list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of DNS Forwarder Zones", 
  "type": "object"
}

PolicyEdgeCluster (type)

{
  "additionalProperties": false, 
  "description": "Edge Cluster.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "PolicyEdgeCluster", 
  "module_id": "PolicyEnforcementPointManagement", 
  "policy_hierarchical_children": [
    "ChildPolicyEdgeNode"
  ], 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "inter_site_forwarding_enabled": {
      "description": "Flag to indicate status of inter site l2 and l3 forwarding in federation.", 
      "readonly": true, 
      "title": "Inter site forwarding is enabled if true", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "nsx_id": {
      "description": "UUID of Edge Cluster on NSX-T enforcement point.", 
      "readonly": true, 
      "title": "Edge Cluster UUID on NSX-T Enforcement Point", 
      "type": "string"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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"
    }, 
    "rtep_ips": {
      "description": "List of remote tunnel endpoint ipaddress configured on edge cluster.", 
      "items": {
        "$ref": "IPAddress
      }, 
      "readonly": true, 
      "title": "Remote tunnel endpoint IP addresses.", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "search_dsl_exclude": true, 
  "title": "Edge Cluster", 
  "type": "object"
}

PolicyEdgeClusterInterSiteBgpSummary (type)

{
  "id": "PolicyEdgeClusterInterSiteBgpSummary", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "edge_cluster_path": {
      "description": "Edge cluster path whose status is being reported.", 
      "readonly": true, 
      "required": true, 
      "title": "Edge node path", 
      "type": "string"
    }, 
    "edge_nodes": {
      "description": "Status of all edge nodes within cluster.", 
      "items": {
        "$ref": "PolicyEdgeNodeInterSiteBgpSummary
      }, 
      "readonly": true, 
      "title": "Individual edge nodes status", 
      "type": "array"
    }
  }, 
  "type": "object"
}

PolicyEdgeClusterInterSiteStatus (type)

{
  "additionalProperties": false, 
  "id": "PolicyEdgeClusterInterSiteStatus", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "edge_cluster_name": {
      "description": "Name of the edge cluster whose status is being reported.", 
      "readonly": true, 
      "title": "Edge cluster name", 
      "type": "string"
    }, 
    "edge_cluster_path": {
      "description": "Policy path of the edge cluster whose status is being reported.", 
      "readonly": true, 
      "required": true, 
      "title": "Edge cluster path", 
      "type": "string"
    }, 
    "last_update_timestamp": {
      "$ref": "EpochMsTimestamp, 
      "description": "Timestamp when the edge cluster inter-site status was last updated.", 
      "readonly": true, 
      "required": true, 
      "title": "Last updated timestamp"
    }, 
    "member_status": {
      "description": "Per edge node inter-site status.", 
      "items": {
        "$ref": "PolicyEdgeClusterMemberInterSiteStatus
      }, 
      "readonly": true, 
      "title": "Per edge node inter-site status", 
      "type": "array"
    }, 
    "overall_status": {
      "description": "Overall status of all edge nodes IBGP status in the edge cluster.", 
      "enum": [
        "UP", 
        "DOWN", 
        "DEGRADED", 
        "UNKNOWN"
      ], 
      "readonly": true, 
      "title": "Overall IBGP status in the edge cluster", 
      "type": "string"
    }
  }, 
  "type": "object"
}

PolicyEdgeClusterListRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "Policy Edge Cluster list request parameters.", 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "PolicyEdgeClusterListRequestParameters", 
  "module_id": "PolicyEnforcementPointManagement", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Policy Edge Cluster List Request Parameters", 
  "type": "object"
}

PolicyEdgeClusterListResult (type)

{
  "additionalProperties": false, 
  "description": "Paged Collection of Edge Cluster", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "PolicyEdgeClusterListResult", 
  "module_id": "PolicyEnforcementPointManagement", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Edge Cluster list result.", 
      "items": {
        "$ref": "PolicyEdgeCluster
      }, 
      "required": true, 
      "title": "Edge Cluster List Result", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of Edge Cluster", 
  "type": "object"
}

PolicyEdgeClusterMemberInterSiteStatus (type)

{
  "additionalProperties": false, 
  "id": "PolicyEdgeClusterMemberInterSiteStatus", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "edge_node_path": {
      "$ref": "ResourceReference, 
      "description": "Edge node details from where the status is being retrived.", 
      "readonly": true, 
      "required": true, 
      "title": "Edge node path"
    }, 
    "established_bgp_sessions": {
      "description": "Total number of current established inter-site IBGP sessions.", 
      "readonly": true, 
      "title": "Established inter-site IBGP sessions", 
      "type": "integer"
    }, 
    "neighbor_status": {
      "description": "Inter-site BGP neighbor status.", 
      "items": {
        "$ref": "PolicyBgpNeighborStatus
      }, 
      "readonly": true, 
      "title": "BGP neighbor status", 
      "type": "array"
    }, 
    "status": {
      "description": "Edge node IBGP status", 
      "enum": [
        "UP", 
        "DOWN", 
        "DEGRADED", 
        "UNKNOWN"
      ], 
      "readonly": true, 
      "title": "Edge node IBGP status", 
      "type": "string"
    }, 
    "total_bgp_sessions": {
      "description": "Total number of inter-site IBGP sessions.", 
      "readonly": true, 
      "title": "Total inter-site IBGP sessions", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

PolicyEdgeNode (type)

{
  "additionalProperties": false, 
  "description": "This object serves as a representation of the edge cluster index to which the edge node connects. It should not be mistaken for the edge / transport node itself. Consuming services can refer to the nsx_id property to fetch the UUID of the edge / transport node that is attached to this index.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "PolicyEdgeNode", 
  "module_id": "PolicyEnforcementPointManagement", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "member_index": {
      "description": "The numerical value of the member index in the edge cluster that this object represents and to which the edge node connects.", 
      "readonly": true, 
      "title": "Member Index", 
      "type": "integer"
    }, 
    "nsx_id": {
      "description": "UUID of edge node on NSX-T enforcement point.", 
      "readonly": true, 
      "title": "Edge Node UUID on NSX-T Enforcement Point", 
      "type": "string"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "search_dsl_exclude": true, 
  "title": "Policy Edge Node", 
  "type": "object"
}

PolicyEdgeNodeInterSiteBgpSummary (type)

{
  "id": "PolicyEdgeNodeInterSiteBgpSummary", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "edge_node_path": {
      "description": "Edge node path whose status is being reported.", 
      "readonly": true, 
      "required": true, 
      "title": "Edge node path", 
      "type": "string"
    }, 
    "last_update_timestamp": {
      "$ref": "EpochMsTimestamp, 
      "description": "Timestamp when the inter-site IBGP neighbors status was last updated.", 
      "readonly": true, 
      "required": true, 
      "title": "Last updated timestamp"
    }, 
    "neighbor_status": {
      "description": "Status of all inter-site IBGP neighbors.", 
      "items": {
        "$ref": "PolicyBgpNeighborStatus
      }, 
      "readonly": true, 
      "title": "Inter-site IBGP neighbors status", 
      "type": "array"
    }
  }, 
  "type": "object"
}

PolicyEdgeNodeListRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "Edge Node list request parameters.", 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "PolicyEdgeNodeListRequestParameters", 
  "module_id": "PolicyEnforcementPointManagement", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Edge Node List Request Parameters", 
  "type": "object"
}

PolicyEdgeNodeListResult (type)

{
  "additionalProperties": false, 
  "description": "Paged Collection of Edge Node", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "PolicyEdgeNodeListResult", 
  "module_id": "PolicyEnforcementPointManagement", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Edge Node list result.", 
      "items": {
        "$ref": "PolicyEdgeNode
      }, 
      "required": true, 
      "title": "Edge Node List Result", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of Edge Node", 
  "type": "object"
}

PolicyExcludeList (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "PolicyExcludeList", 
  "module_id": "PolicyFirewallConfiguration", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "members": {
      "description": "List of the members in the exclude list", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 100, 
      "required": true, 
      "title": "ExcludeList member list", 
      "type": "array"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "type": "object"
}

PolicyFineTuningResourceInfo (type)

{
  "additionalProperties": false, 
  "description": "It represent the resource with details of name and fields it owns.", 
  "id": "PolicyFineTuningResourceInfo", 
  "module_id": "PolicyFineTuning", 
  "properties": {
    "fields": {
      "items": {
        "$ref": "PolicyFineTuningResourceInfoDetail
      }, 
      "required": true, 
      "title": "List of all field of any resource", 
      "type": "array"
    }, 
    "resource_name": {
      "description": "It will represent resource with name and fields.", 
      "required": true, 
      "title": "Resource name", 
      "type": "string"
    }
  }, 
  "title": "Contains the detail of resources with name and fields", 
  "type": "object"
}

PolicyFineTuningResourceInfoDetail (type)

{
  "additionalProperties": false, 
  "description": "Contains the details of resource field", 
  "id": "PolicyFineTuningResourceInfoDetail", 
  "module_id": "PolicyFineTuning", 
  "properties": {
    "field_name": {
      "description": "It will represent resource with name and fields.", 
      "required": true, 
      "title": "Resource name", 
      "type": "string"
    }, 
    "sub_type": {
      "$ref": "PolicyFineTuningResourceInfo, 
      "required": true, 
      "title": "List of all field of any resource"
    }
  }, 
  "title": "Contains the details resources with field type and name", 
  "type": "object"
}

PolicyFirewallCPUMemThresholdsProfileBindingMap (type)

{
  "additionalProperties": false, 
  "description": "This entity will be used to establish association between CPU Memory Thresholds Profile and Transport Node. Using this entity, user can specify intent for applying Firewall CPU Memory Thresholds Profile to particular Transport Node.", 
  "extends": {
    "$ref": "ProfileBindingMap
  }, 
  "id": "PolicyFirewallCPUMemThresholdsProfileBindingMap", 
  "module_id": "PolicyFirewallCPUMemThresholdsProfileBinding", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "profile_path": {
      "description": "PolicyPath of associated Profile", 
      "required": true, 
      "title": "Profile Path", 
      "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": "Sequence number is used to resolve conflicts when two profiles get applied to a single node. Lower value gets higher precedence. Two binding maps having the same profile path should have the same sequence number.", 
      "maximum": 4294967295, 
      "minimum": 0, 
      "required": true, 
      "title": "Sequence number of this profile binding map", 
      "type": "integer"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "transport_nodes": {
      "description": "References of transport nodes on which the profile intended to be applied.", 
      "items": {
        "$ref": "PolicyResourceReference
      }, 
      "title": "References of transport nodes", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Policy DFW CPU Memory Thresholds Profile binding map", 
  "type": "object"
}

PolicyFirewallCPUMemThresholdsProfileBindingMapListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "PolicyFirewallCPUMemThresholdsProfileBindingMapListRequestParameters", 
  "module_id": "PolicyFirewallCPUMemThresholdsProfileBinding", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Policy Firewall CPU Memory Thresholds Profile Binding Map list request parameters", 
  "type": "object"
}

PolicyFirewallCPUMemThresholdsProfileBindingMapListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "PolicyFirewallCPUMemThresholdsProfileBindingMapListResult", 
  "module_id": "PolicyFirewallCPUMemThresholdsProfileBinding", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "PolicyFirewallCPUMemThresholdsProfileBindingMap
      }, 
      "required": true, 
      "title": "Firewall CPU Memory Thresholds Profile Binding Map list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged collection of Firewall CPU Memory Thresholds Profile Binding Maps", 
  "type": "object"
}

PolicyFirewallCpuMemThresholdsProfile (type)

{
  "additionalProperties": false, 
  "description": "A profile holding CPU and memory thresholds configuration.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "PolicyFirewallCpuMemThresholdsProfile", 
  "module_id": "PolicyProfile", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "cpu_threshold_percentage": {
      "default": 90, 
      "description": "CPU utilization thresholds percentage to monitor and report for distributed firewall.", 
      "maximum": 100, 
      "minimum": 10, 
      "required": true, 
      "title": "CPU utilization thresholds percentage", 
      "type": "integer"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "mem_threshold_percentage": {
      "default": 90, 
      "description": "Heap memory thresholds percentage to monitor and report for distributed firewall.", 
      "maximum": 100, 
      "minimum": 10, 
      "required": true, 
      "title": "Heap memory thresholds utilization percentage", 
      "type": "integer"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Firewall CPU and memory thresholds profile", 
  "type": "object"
}

PolicyFirewallCpuMemThresholdsProfileListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "PolicyFirewallCpuMemThresholdsProfileListResult", 
  "module_id": "PolicyProfile", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "PolicyFirewallCpuMemThresholdsProfile
      }, 
      "required": true, 
      "title": "PolicyFirewallCpuMemThresholdsProfile list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of PolicyFirewallCpuMemThresholdsProfile", 
  "type": "object"
}

PolicyFirewallFloodProtectionProfileBindingMap (type)

{
  "additionalProperties": false, 
  "description": "This entity will be used to establish association between Firewall Flood Protection profile and Group. Using this entity, user can specify intent for applying Firewall Flood Protection profile to particular Group.", 
  "extends": {
    "$ref": "ProfileBindingMap
  }, 
  "id": "PolicyFirewallFloodProtectionProfileBindingMap", 
  "module_id": "PolicyFirewallFloodProtectionProfileBinding", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "profile_path": {
      "description": "PolicyPath of associated Profile", 
      "required": true, 
      "title": "Profile Path", 
      "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": "Sequence number is used to resolve conflicts when two profiles get applied to a single port. Lower value gets higher precedence. Two binding maps having the same profile path should have the same sequence number.", 
      "required": true, 
      "title": "Sequence number of this profile binding map.", 
      "type": "integer"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Policy DFW Flood Protection Profile binding map", 
  "type": "object"
}

PolicyFirewallFloodProtectionProfileBindingMapListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "PolicyFirewallFloodProtectionProfileBindingMapListRequestParameters", 
  "module_id": "PolicyFirewallFloodProtectionProfileBinding", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Policy Firewall Flood Protection Profile Binding Map list request parameters", 
  "type": "object"
}

PolicyFirewallFloodProtectionProfileBindingMapListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "PolicyFirewallFloodProtectionProfileBindingMapListResult", 
  "module_id": "PolicyFirewallFloodProtectionProfileBinding", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "PolicyFirewallFloodProtectionProfileBindingMap
      }, 
      "required": true, 
      "title": "Firewall Flood Protection Profile Binding Map list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged collection of Firewall Flood Protection Profile Binding Maps", 
  "type": "object"
}

PolicyFirewallScheduler (type)

{
  "additionalProperties": false, 
  "description": "An entity that encapsulates attributes to schedule firewall rules to be active to allow or block traffic for a specific period of time. Note that at least one property out of \"days\", \"start_time\", \"end_time\", \"start_date\", \"end_date\" is required.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "PolicyFirewallScheduler", 
  "module_id": "PolicyFirewallScheduler", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "days": {
      "description": "Days of week on which rules will be enforced. If property is omitted, then days of the week will not considered while calculating the firewall schedule. It should not be present when the recurring flag is false.", 
      "items": {
        "$ref": "PolicyFirewallSchedulerDays
      }, 
      "required": false, 
      "title": "Days of the week", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "end_date": {
      "description": "End date on which schedule to end. Example, 12/22/2019.", 
      "required": true, 
      "title": "End date in MM/DD/YYYY", 
      "type": "string"
    }, 
    "end_time": {
      "description": "If recurring field is set false, then this field must be present. The schedule will be enforced till the end time of the specified end date. If recurring field is set true, then this field should not be present.", 
      "required": false, 
      "title": "End time", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "recurring": {
      "default": true, 
      "description": "Flag to indicate whether firewall schedule recurs or not. The default value is true and it should be set to false when the firewall schedule does not recur and is a one time time interval.", 
      "required": true, 
      "title": "Firewall schedule recurring flag", 
      "type": "boolean"
    }, 
    "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"
    }, 
    "start_date": {
      "description": "Start date on which schedule to start. Example, 02/22/2019.", 
      "required": true, 
      "title": "Start date in MM/DD/YYYY", 
      "type": "string"
    }, 
    "start_time": {
      "description": "Time in 24 hour and minutes in multiple of 30. Example, 9:00. If recurring field is set false, then this field must be present. The schedule will start getting enforced from the start time of the specified start date. If recurring field is set true, then this field should not be present.", 
      "required": false, 
      "title": "Start time", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "time_interval": {
      "description": "The recurring time interval in a day during which the schedule will be applicable. It should not be present when the recurring flag is false.", 
      "items": {
        "$ref": "PolicyTimeIntervalValue
      }, 
      "maxItems": 1, 
      "required": false, 
      "title": "Recurring time interval", 
      "type": "array"
    }, 
    "timezone": {
      "description": "Host Timezone to be used to enforce firewall rules.", 
      "enum": [
        "UTC", 
        "LOCAL"
      ], 
      "required": true, 
      "title": "Host timezone", 
      "type": "string"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Policy Firewall Scheduler entity", 
  "type": "object"
}

PolicyFirewallSchedulerDays (type)

{
  "additionalProperties": false, 
  "enum": [
    "SUNDAY", 
    "MONDAY", 
    "TUESDAY", 
    "WEDNESDAY", 
    "THURSDAY", 
    "FRIDAY", 
    "SATURDAY"
  ], 
  "id": "PolicyFirewallSchedulerDays", 
  "module_id": "PolicyFirewallScheduler", 
  "title": "Day on which scheduled firewall rule will be enforced", 
  "type": "string"
}

PolicyFirewallSchedulerDeleteRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "DeleteRequestParameters
  }, 
  "id": "PolicyFirewallSchedulerDeleteRequestParameters", 
  "module_id": "PolicyFirewallScheduler", 
  "properties": {
    "force": {
      "default": false, 
      "description": "If true, deleting the resource succeeds even if it is being referred as a resource reference.", 
      "title": "Force delete the resource even if it is being used somewhere\n", 
      "type": "boolean"
    }
  }, 
  "title": "Policy Firewall Scheduler delete request parameters", 
  "type": "object"
}

PolicyFirewallSchedulerListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "PolicyFirewallSchedulerListRequestParameters", 
  "module_id": "PolicyFirewallScheduler", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Policy Firewall Scheduler list request parameters", 
  "type": "object"
}

PolicyFirewallSchedulerListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "PolicyFirewallSchedulerListResult", 
  "module_id": "PolicyFirewallScheduler", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "PolicyFirewallScheduler
      }, 
      "readonly": true, 
      "title": "Paged collection of PolicyFirewallSchedulers", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "List result of PolicyFirewallSchedulers", 
  "type": "object"
}

PolicyFirewallSessionTimerProfile (type)

{
  "description": "A profile holding TCP, UDP and ICMP session timeout configuration.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "PolicyFirewallSessionTimerProfile", 
  "module_id": "PolicyFirewallSessionTimerProfile", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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"
    }, 
    "icmp_error_reply": {
      "default": 10, 
      "description": "The timeout value for the connection after an ICMP error came back in response to an ICMP packet. The default value for Edges (i.e, Gateway, or Logical Router) may be different than Distributed Firewall hosts.", 
      "maximum": 4320000, 
      "minimum": 10, 
      "readonly": false, 
      "required": true, 
      "title": "Timeout after ICMP error", 
      "type": "integer"
    }, 
    "icmp_first_packet": {
      "default": 20, 
      "description": "The timeout value of connection in seconds after the first packet. This will be the initial timeout for the new ICMP flow. The default value for Edges (i.e, Gateway, or Logical Router) may be different than Distributed Firewall hosts.", 
      "maximum": 4320000, 
      "minimum": 10, 
      "readonly": false, 
      "required": true, 
      "title": "First packet connection timeout", 
      "type": "integer"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "tcp_closed": {
      "default": 20, 
      "description": "The timeout value of connection in seconds after one endpoint sends an RST. The default value for Edges (i.e, Gateway, or Logical Router) may be different than Distributed Firewall hosts.", 
      "maximum": 4320000, 
      "minimum": 10, 
      "readonly": false, 
      "required": true, 
      "title": "Timeout after RST", 
      "type": "integer"
    }, 
    "tcp_closing": {
      "default": 120, 
      "description": "The timeout value of connection in seconds after the first FIN has been sent. The default value for Edges (i.e, Gateway, or Logical Router) may be different than Distributed Firewall hosts.", 
      "maximum": 4320000, 
      "minimum": 10, 
      "readonly": false, 
      "required": true, 
      "title": "Timeout after first TN", 
      "type": "integer"
    }, 
    "tcp_established": {
      "default": 43200, 
      "description": "The timeout value of connection in seconds once the connection has become fully established. The default value for Edges (i.e, Gateway,or Logical Router) may be different than Distributed Firewall hosts.", 
      "maximum": 4320000, 
      "minimum": 120, 
      "readonly": false, 
      "required": true, 
      "title": "Connection timeout", 
      "type": "integer"
    }, 
    "tcp_finwait": {
      "default": 45, 
      "description": "The timeout value of connection in seconds after both FINs have been exchanged and connection is closed. The default value for Edges (i.e, Gateway, or Logical Router) may be different than Distributed Firewall hosts.", 
      "maximum": 4320000, 
      "minimum": 10, 
      "readonly": false, 
      "required": true, 
      "title": "Timeout after FINs exchanged", 
      "type": "integer"
    }, 
    "tcp_first_packet": {
      "default": 120, 
      "description": "The timeout value of connection in seconds after the first packet has been sent. The default value for Edges (i.e, Gateway, or Logical Router) may be different than Distributed Firewall hosts.", 
      "maximum": 4320000, 
      "minimum": 10, 
      "readonly": false, 
      "required": true, 
      "title": "Connection timout after first packet", 
      "type": "integer"
    }, 
    "tcp_opening": {
      "default": 30, 
      "description": "The timeout value of connection in seconds after a second packet has been transferred. The default value for Edges (i.e, Gateway, or Logical Router) may be different than Distributed Firewall hosts.", 
      "maximum": 4320000, 
      "minimum": 10, 
      "readonly": false, 
      "required": true, 
      "title": "Connection timout after second packet", 
      "type": "integer"
    }, 
    "udp_first_packet": {
      "default": 60, 
      "description": "The timeout value of connection in seconds after the first packet. This will be the initial timeout for the new UDP flow. The default value for Edges (i.e, Gateway, or Logical Router) may be different than Distributed Firewall hosts.", 
      "maximum": 4320000, 
      "minimum": 10, 
      "readonly": false, 
      "required": true, 
      "title": "Connection timout after first packet", 
      "type": "integer"
    }, 
    "udp_multiple": {
      "default": 60, 
      "description": "The timeout value of connection in seconds if both hosts have sent packets. The default value for Edges (i.e, Gateway, or Logical Router) may be different than Distributed Firewall hosts.", 
      "maximum": 4320000, 
      "minimum": 10, 
      "readonly": false, 
      "required": true, 
      "title": "Timeout after hosts sent packet", 
      "type": "integer"
    }, 
    "udp_single": {
      "default": 30, 
      "description": "The timeout value of connection in seconds if the source host sends more than one packet but the destination host has never sent one back. The default value for Edges (i.e, Gateway, or Logical Router) may be different than Distributed Firewall hosts.", 
      "maximum": 4320000, 
      "minimum": 10, 
      "readonly": false, 
      "required": true, 
      "title": "Connection timeout for destination", 
      "type": "integer"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Policy Firewall Session timeout profile", 
  "type": "object"
}

PolicyFirewallSessionTimerProfileBindingMap (type)

{
  "additionalProperties": false, 
  "description": "This entity will be used to establish association between Firewall Timer session profile and Group. Using this entity, user can specify intent for applying Firewall Timer session profile to particular Group.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "PolicyFirewallSessionTimerProfileBindingMap", 
  "module_id": "PolicyFirewallSessionTimerProfileBinding", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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"
    }, 
    "firewall_session_timer_profile_path": {
      "description": "PolicyPath of associated Firewall Timer Session Profile", 
      "required": true, 
      "title": "Firewall Session Timer Profile Path", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": "Sequence number is used to resolve conflicts when two profiles get applied to a single port. Lower value gets higher precedence. Two binding maps having the same profile path should have the same sequence number.", 
      "required": false, 
      "title": "Sequence number of this profile binding map.", 
      "type": "integer"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Policy DFW Timer Session Profile binding map", 
  "type": "object"
}

PolicyFirewallSessionTimerProfileBindingMapListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "PolicyFirewallSessionTimerProfileBindingMapListRequestParameters", 
  "module_id": "PolicyFirewallSessionTimerProfileBinding", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Policy Firewall Session Timer Profile Binding Map list request parameters", 
  "type": "object"
}

PolicyFirewallSessionTimerProfileBindingMapListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "PolicyFirewallSessionTimerProfileBindingMapListResult", 
  "module_id": "PolicyFirewallSessionTimerProfileBinding", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "PolicyFirewallSessionTimerProfileBindingMap
      }, 
      "required": true, 
      "title": "Firewall Session Timer Profile Binding Map list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged collection of Firewall Session Timer Profile Binding Maps", 
  "type": "object"
}

PolicyFirewallSessionTimerProfileListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "PolicyFirewallSessionTimerProfileListRequestParameters", 
  "module_id": "PolicyFirewallSessionTimerProfile", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Policy Firewall Session timeout profile list request parameters", 
  "type": "object"
}

PolicyFirewallSessionTimerProfileListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "PolicyFirewallSessionTimerProfileListResult", 
  "module_id": "PolicyFirewallSessionTimerProfile", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "PolicyFirewallSessionTimerProfile
      }, 
      "required": true, 
      "title": "Policy Firewall Session timeout profile list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of Policy Firewall Session timeout profiles", 
  "type": "object"
}

PolicyGroupIPMembersListResult (type)

{
  "additionalProperties": false, 
  "description": "Paginated collection of IP members belonging to a Group.", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "PolicyGroupIPMembersListResult", 
  "module_id": "PolicyGroupRealization", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "IPElement
      }, 
      "required": true, 
      "title": "Paged Collection of IP addresses that belong to the given Group", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Group IP members list result", 
  "type": "object"
}

PolicyGroupMemberDetails (type)

{
  "additionalProperties": false, 
  "description": "Details of the member belonging to a Group", 
  "id": "PolicyGroupMemberDetails", 
  "module_id": "PolicyGroupRealization", 
  "properties": {
    "display_name": {
      "readonly": true, 
      "required": true, 
      "title": "The display name of the member on the enforcement point", 
      "type": "string"
    }, 
    "id": {
      "readonly": true, 
      "required": true, 
      "title": "The ID of the member on the enforcement point", 
      "type": "string"
    }, 
    "path": {
      "readonly": true, 
      "required": true, 
      "title": "The path of the member, if relevant", 
      "type": "string"
    }
  }, 
  "title": "Group member details", 
  "type": "object"
}

PolicyGroupMembersListResult (type)

{
  "additionalProperties": false, 
  "description": "Paginated collection of members belonging to a Group.", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "PolicyGroupMembersListResult", 
  "module_id": "PolicyGroupRealization", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "PolicyGroupMemberDetails
      }, 
      "required": true, 
      "title": "Paged Collection of members that belong to the given Group", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Group members list result", 
  "type": "object"
}

PolicyGroupServiceAssociationsRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "PolicyGroupServiceAssociationsRequestParameters", 
  "module_id": "PolicyGroupRealization", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "intent_path": {
      "description": "Path of the entity for which associated services are to be fetched.", 
      "required": true, 
      "title": "Path of the entity", 
      "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": "Associations list request parameters", 
  "type": "object"
}

PolicyIKEDigestAlgorithm (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "The IKEDigestAlgorithms are used to verify message integrity during IKE negotiation. SHA1 produces 160 bits hash and SHA2_256 produces 256 bit hash.", 
  "enum": [
    "SHA1", 
    "SHA2_256"
  ], 
  "id": "PolicyIKEDigestAlgorithm", 
  "module_id": "PolicyL3Vpn", 
  "title": "Digest Algorithms used in IKE negotiations", 
  "type": "string"
}

PolicyIKEEncryptionAlgorithm (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "IKEEncryption algorithms are used to ensure confidentiality of the messages exchanged during IKE negotiations. AES stands for Advanced Encryption Standards. AES_128 uses 128-bit keys whereas AES_256 uses 256-bit keys for encryption and decryption. AES_GCM stands for Advanced Encryption Standard(AES) in Galois/Counter Mode(GCM) and is used to provide both confidentiality and data origin authentication. AES_GCM composed of two separate functions one for encryption(AES) and one for authentication(GMAC). AES_GCM algorithms will be available with IKE_V2 version only. AES_GMAC_128 uses 128-bit keys. AES_GMAC_192 uses 192-bit keys. AES_GMAC_256 uses 256-bit keys.", 
  "enum": [
    "AES_128", 
    "AES_256", 
    "AES_GCM_128", 
    "AES_GCM_192", 
    "AES_GCM_256"
  ], 
  "id": "PolicyIKEEncryptionAlgorithm", 
  "module_id": "PolicyL3Vpn", 
  "title": "Encryption algorithms used in IKE", 
  "type": "string"
}

PolicyIKEVersion (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "IKE protocol version to be used. IKE-Flex will initiate IKE-V2 and responds to both IKE-V1 and IKE-V2.", 
  "enum": [
    "IKE_V1", 
    "IKE_V2", 
    "IKE_FLEX"
  ], 
  "id": "PolicyIKEVersion", 
  "module_id": "PolicyL3Vpn", 
  "title": "IKE version", 
  "type": "string"
}

PolicyIPAddressInfo (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "Used to specify the display name and value of the IPv4Address.", 
  "id": "PolicyIPAddressInfo", 
  "module_id": "PolicyL3Vpn", 
  "properties": {
    "address_value": {
      "$ref": "IPv4Address, 
      "description": "Value of the IPv4Address.", 
      "required": true, 
      "title": "Value of the IPv4Address"
    }, 
    "display_name": {
      "description": "Display name used to help identify the IPv4Address.", 
      "required": false, 
      "title": "Display name of the IPv4Address", 
      "type": "string"
    }, 
    "next_hop": {
      "$ref": "IPv4Address, 
      "description": "Next hop used in auto-plumbing of static route. If a value is not provided, static route will not be auto-plumbed.", 
      "required": false, 
      "title": "Next Hop of the IPv4Address"
    }
  }, 
  "title": "IP address information", 
  "type": "object"
}

PolicyIgmpProfile (type)

{
  "additionalProperties": false, 
  "description": "IGMP profile.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "PolicyIgmpProfile", 
  "module_id": "PolicyMulticast", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "last_member_query_interval": {
      "default": 1, 
      "description": "Max Response Time inserted into Group-Specific Queries sent in response to Leave Group messages, and is also the amount of time between Group-Specific Query messages. This value may be tuned to modify the \"leave latency\" of the network. A reduced value results in reduced time to detect the loss of the last member of a group.", 
      "maximum": 25, 
      "minimum": 1, 
      "required": false, 
      "title": "Max Response Time", 
      "type": "int"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "query_interval": {
      "default": 30, 
      "description": "Interval(seconds) between general IGMP host-query messages.", 
      "maximum": 1800, 
      "minimum": 1, 
      "required": false, 
      "title": "Interval between general IGMP host-query messages", 
      "type": "int"
    }, 
    "query_max_response_time": {
      "default": 10, 
      "description": "The query response interval(seconds) is the maximum amount of time that can elapse between when the querier router sends a host-query message and when it receives a response from a host. Configuring this interval allows admins to adjust the burstiness of IGMP messages on the subnet; larger values make the traffic less bursty, as host responses are spread out over a larger interval.  The number of seconds represented by the query_max_response_time must be less than the query_interval.", 
      "maximum": 25, 
      "minimum": 1, 
      "required": false, 
      "title": "The maximum elapsed time between response", 
      "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"
    }, 
    "robustness_variable": {
      "default": 2, 
      "description": "The Robustness Variable allows tuning for the expected packet loss on a subnet. If a subnet is expected to be lossy, the Robustness Variable may be increased. IGMP is robust to (Robustness Variable-1) packet losses. The Robustness Variable must not be zero, and SHOULD NOT be one.", 
      "maximum": 255, 
      "minimum": 1, 
      "required": false, 
      "title": "The Robustness Variable", 
      "type": "int"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "IGMP Profile", 
  "type": "object"
}

PolicyInsertParameters (type)

{
  "description": "Parameters to let the admin specify a relative position of a security policy or rule w.r.t to another one.", 
  "id": "PolicyInsertParameters", 
  "module_id": "Policy", 
  "properties": {
    "anchor_path": {
      "required": false, 
      "title": "The security policy/rule path if operation is 'insert_after' or\n'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 security policy/rule needs to be placed\n", 
  "type": "object"
}

PolicyInterfaceOspfConfig (type)

{
  "additionalProperties": false, 
  "description": "OSPF Interface configuration.", 
  "id": "PolicyInterfaceOspfConfig", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "bfd_path": {
      "description": "This filed is valid only if enable_bfd is set to TRUE. If enable_bfd flag is set to TRUE, this profile will be applied to all OSPF peers in this interface. If this field is empty, bfd_path will refer to Tier-0 global BFD profile.", 
      "required": false, 
      "title": "Policy path of BFD profile", 
      "type": "string"
    }, 
    "dead_interval": {
      "default": 40, 
      "description": "Specifies the number of seconds that router must wait before it declares a OSPF neighbor router down because it has not received OSPF hello packet. OSPF dead interval should be minimum 3 times greater than the hello interval", 
      "maximum": 65535, 
      "minimum": 3, 
      "required": false, 
      "title": "OSPF dead interval in seconds", 
      "type": "int"
    }, 
    "enable_bfd": {
      "description": "Enable/Disable OSPF to register for BFD event. Use FALSE to disable BFD.", 
      "required": false, 
      "title": "enable BFD for OSPF", 
      "type": "boolean"
    }, 
    "enabled": {
      "default": false, 
      "description": "enable/disable OSPF on the interface. If enabled flag not specified, defailt is disable OSPF.", 
      "title": "enable/disable OSPF", 
      "type": "boolean"
    }, 
    "hello_interval": {
      "default": 10, 
      "description": "Specifies the interval between the hello packets that OSPF sends on this interface. OSPF hello interval should be less than the dead interval", 
      "maximum": 21845, 
      "minimum": 1, 
      "required": false, 
      "title": "OSPF hello interval in seconds", 
      "type": "int"
    }, 
    "network_type": {
      "default": "BROADCAST", 
      "description": "Configure OSPF networkt type, default is BROADCAST network type", 
      "enum": [
        "BROADCAST", 
        "P2P"
      ], 
      "required": false, 
      "title": "Configure OSPF networkt type", 
      "type": "string"
    }, 
    "ospf_area": {
      "description": "Attache Tier0 Interface to specified OSPF Area. all peers.", 
      "required": true, 
      "title": "Attach Tier0 Interface to specified OSPF Area", 
      "type": "string"
    }
  }, 
  "title": "OSPF Interface configuration", 
  "type": "object"
}

PolicyInterfaceStatistics (type)

{
  "additionalProperties": false, 
  "description": "Tier0 or Tier1 interface statistics on specific Enforcement Point.", 
  "extends": {
    "$ref": "LogicalRouterPortStatistics
  }, 
  "id": "PolicyInterfaceStatistics", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "logical_router_port_id": {
      "required": true, 
      "title": "The ID of the logical router port", 
      "type": "string"
    }, 
    "per_node_statistics": {
      "additionalProperties": false, 
      "items": {
        "$ref": "LogicalRouterPortStatisticsPerNode
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Per Node Statistics", 
      "type": "array"
    }
  }, 
  "title": "Tier0 or Tier1 interface statistics on specific Enforcement Point", 
  "type": "object"
}

PolicyInterfaceStatisticsSummary (type)

{
  "additionalProperties": false, 
  "description": "Tier0 or Tier1 interface statistics on specific Enforcement Point.", 
  "extends": {
    "$ref": "LogicalRouterPortStatisticsSummary
  }, 
  "id": "PolicyInterfaceStatisticsSummary", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "interface_policy_path": {
      "description": "Policy path for the interface", 
      "title": "Policy path for the interface", 
      "type": "string"
    }, 
    "last_update_timestamp": {
      "$ref": "EpochMsTimestamp, 
      "readonly": true, 
      "title": "Timestamp when the data was last updated; unset if data source has never updated the data."
    }, 
    "logical_router_port_id": {
      "required": true, 
      "title": "The ID of the logical router port", 
      "type": "string"
    }, 
    "rx": {
      "$ref": "LogicalRouterPortCounters, 
      "readonly": true, 
      "required": false
    }, 
    "tx": {
      "$ref": "LogicalRouterPortCounters, 
      "readonly": true, 
      "required": false
    }
  }, 
  "title": "Tier0 or Tier1 interface statistics on specific Enforcement Point", 
  "type": "object"
}

PolicyL2TablesParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "TransportNodeIdParameters
  }, 
  "id": "PolicyL2TablesParameters", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "enforcement_point_path": {
      "description": "Enforcement point path.", 
      "title": "String Path of the enforcement point", 
      "type": "string"
    }, 
    "source": {
      "$ref": "DataSourceType, 
      "required": false, 
      "title": "The data source, either realtime or cached. If not provided, cached data is returned."
    }, 
    "transport_node_id": {
      "required": false, 
      "title": "TransportNode Id", 
      "type": "string"
    }
  }, 
  "title": "Layer-2 table request parameters", 
  "type": "object"
}

PolicyLabel (type)

{
  "additionalProperties": false, 
  "description": "Label to reference group of policy entities of same type.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "PolicyLabel", 
  "module_id": "PolicyLabel", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "refs": {
      "description": "Policy entity paths referred by the label instance", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Policy entity paths referred by the label instance", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "type": {
      "description": "Policy intent entity type from PolicyResourceType", 
      "required": true, 
      "title": "Policy intent entity type from PolicyResourceType", 
      "type": "string"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Label to reference group of policy entities of same type.", 
  "type": "object"
}

PolicyLabelListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "PolicyLabelListRequestParameters", 
  "module_id": "PolicyLabel", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "PolicyLabel list request parameters", 
  "type": "object"
}

PolicyLabelListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "PolicyLabelListResult", 
  "module_id": "PolicyLabel", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "PolicyLabel
      }, 
      "required": true, 
      "title": "Policy label list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of Domains", 
  "type": "object"
}

PolicyLbMonitorProfile (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "description": "All the types of PolicyLbMonitorProfile extend from this abstract class. This is present for extensibility.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "PolicyLbMonitorProfile", 
  "module_id": "TempPolicyLoadBalancer", 
  "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: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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"
    }, 
    "fall_count": {
      "default": 3, 
      "description": "Only if a healthcheck fails consecutively for a specified number of times, given with fall_count, to a member will the member status be marked DOWN.", 
      "required": false, 
      "title": "Monitor fall count for active healthchecks", 
      "type": "integer"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "interval": {
      "default": 5, 
      "description": "Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group.", 
      "required": false, 
      "title": "Monitor interval in seconds for active healthchecks", 
      "type": "integer"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "monitor_port": {
      "description": "Typically, monitors perform healthchecks to Group members using the member IP address and pool_port. However, in some cases, customers prefer to run healthchecks against a different port than the pool member port which handles actual application traffic. In such cases, the port to run healthchecks against can be specified in the monitor_port value.", 
      "maximum": 65535, 
      "minimum": 0, 
      "required": false, 
      "title": "Monitor port for active healthchecks", 
      "type": "int"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": [
        "TcpPolicyLbMonitorProfile", 
        "UdpPolicyLbMonitorProfile", 
        "IcmpPolicyLbMonitorProfile", 
        "HttpPolicyLbMonitorProfile", 
        "HttpsPolicyLbMonitorProfile"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "rise_count": {
      "default": 3, 
      "description": "Once a member is DOWN, a specified number of consecutive successful healthchecks specified by rise_count will bring the member back to UP state.", 
      "required": false, 
      "title": "Monitor rise count for active healthchecks", 
      "type": "integer"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "timeout": {
      "default": 15, 
      "description": "Timeout specified in seconds.  After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.", 
      "required": false, 
      "title": "Monitor timeout in seconds for active healthchecks", 
      "type": "integer"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Base class for each type or protocol of PolicyLbMonitorProfile", 
  "type": "object"
}

PolicyLbPersistenceProfile (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "description": "Some applications maintain state and require all relevant connections to be sent to the same server as the application state is not synchronized among servers. Persistence is enabled on a PolicyLbVirtualServer by binding a persistence profile to it.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "PolicyLbPersistenceProfile", 
  "module_id": "TempPolicyLoadBalancer", 
  "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: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": [
        "L4PolicyLbPersistenceProfile", 
        "L7PolicyLbPersistenceProfile", 
        "CustomPolicyLbPersistenceProfile"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Contains the information related to load balancer persistence options", 
  "type": "object"
}

PolicyLbPoolAccess (type)

{
  "additionalProperties": false, 
  "description": "Defining access of a Group from a PolicyLbVirtualServer and binding to PolicyLbMonitorProfile.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "PolicyLbPoolAccess", 
  "module_id": "TempPolicyLoadBalancer", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "algorithm": {
      "default": "ROUND_ROBIN", 
      "description": "Load balanding algorithm controls how the incoming connections are distributed among the members. - ROUND_ROBIN - requests to the application servers are distributed in a round-robin fashion, - LEAST_CONNECTION - next request is assigned to the server with the least number of active connections", 
      "enum": [
        "ROUND_ROBIN", 
        "LEAST_CONNECTION"
      ], 
      "required": false, 
      "title": "Load balancing algorithm", 
      "type": "string"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ip_port_list": {
      "description": "IP Port list for applications within the Group to allow for non-uniform port usage by applications", 
      "items": {
        "$ref": "IPAddressPortPair
      }, 
      "required": false, 
      "title": "IP Port list for applications within the Group", 
      "type": "array"
    }, 
    "lb_monitor_profile": {
      "description": "Path of the PolicyLbMonitorProfile to actively monitor the PolicyLbPoolAccess's Group", 
      "required": false, 
      "title": "Path of the PolicyLbMonitorProfile to actively monitor the PolicyLbPoolAccess's Group", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "pool_port": {
      "description": "Port for LoadBalancer to send connections to the PolicyLbPoolAccess's Group. Pool_port could be optional, if it is not specified, LB will use PolicyLbVirtualServer port to connect to backend servers. If the PolicyLbMonitorProfile is configured in PolicyLbPoolAccess and active monitor IP protocol is TCP/UDP(which requires TCP or UDP port number), monitor_port should be specified if pool_port is unset.", 
      "maximum": 65535, 
      "minimum": 0, 
      "required": false, 
      "title": "Port for LoadBalancer to send traffic", 
      "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"
    }, 
    "source_nat": {
      "default": "ENABLED", 
      "description": "Depending on the topology, Source NAT (SNAT) may be required to ensure traffic from the server destined to the client is received by the load balancer. SNAT can be enabled per pool. If SNAT is not enabled for a pool, then load balancer uses the client IP and port (spoofing) while establishing connections to the servers. This is referred to as no-SNAT or TRANSPARENT mode.  SNAT is enabled by default and will use the load balancer interface IP and an ephemeral port as the source IP and port of the server side connection.", 
      "enum": [
        "ENABLED", 
        "DISABLED"
      ], 
      "required": false, 
      "title": "Source NAT setting of the PolicyLbPoolAccess", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Defining access a Group from a PolicyLbVirtualServer and binding to PolicyLbMonitorProfile", 
  "type": "object"
}

PolicyLbRule (type)

{
  "additionalProperties": false, 
  "description": "Binding of a LbPoolAccess and Group to a PolicyLbVirtualServer used to route application traffic passing through load balancers. PolicyLbRule uses match conditions to match application traffic passing through a PolicyLbVirtualServer using HTTP or HTTPS. Can bind multiple PolicyLbVirtualServers to a Group. Each PolicyLbRule consists of two optional match conditions, each match contidion defines a criterion for application traffic.  If no match conditions are specified, then the PolicyLbRule will always match and it is used typically to define default rules. If more than one match condition is specified, then matching strategy determines if all conditions should match or any one condition should match for the PolicyLbRule to be considered a match.  A match indicates that the PolicyLbVirtualServer should route the request to the Group (parent of PolicyLbRule).", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "PolicyLbRule", 
  "module_id": "TempPolicyLoadBalancer", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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_match": {
      "description": "This condition is used to match HTTP request messages by the specific HTTP header field, Host.  The Host request header specifies the domain name of the server. The supplied Host HTTP header match condition will be matched as a regular expression. The regular expressions in load balancer rules use the features common to both Java regular expressions and Perl Compatible Regular Expressions (PCREs) with some restrictions. Reference http://www.pcre .org for PCRE and the NSX-T Administrator's Guide for the restrictions. Please note, when regular expressions are used in JSON (JavaScript Object Notation) string, every backslash character (\\) needs to be escaped by one additional backslash character.", 
      "required": false, 
      "title": "Host HTTP header match condition", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "lb_virtual_server": {
      "description": "The path of PolicyLbVirtualServer to bind to this PolicyLbRule and its Group", 
      "required": false, 
      "title": "PolicyLbVirtualServer path", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "match_strategy": {
      "default": "ANY", 
      "description": "If more than one match condition is specified, then matching strategy determines if all conditions should match or any one condition should match for the LB Rule to be considered a match. - ALL indicates that both host_match and path_match must match for this PolicyLbRule to be considered a match - ANY indicates that either host_match or patch match may match for this PolicyLbRule to be considered a match", 
      "enum": [
        "ALL", 
        "ANY"
      ], 
      "required": false, 
      "title": "Match strategy for determining match of multiple conditions", 
      "type": "string"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "path_match": {
      "description": "This condition is used to match URIs(Uniform Resource Identifier) of HTTP request messages. The URI field can be specified as a regluar expression. If an HTTP request message is requesting an URI which matches specified regular expression, it matches the condition. The syntax of whole URI looks like this: scheme:[//[user[:password]@]host[:port]][/path][?query][#fragment] This condition matches only the path part of entire URI. The path_match field is used as a regular expression to match URI path of HTTP requests. For example, to match any URI that has \"/image/\" or \"/images/\", uri field can be specified as: \"/image[s]?/\". The regular  expressions in load balancer rules use the features common to both  Java regular expressions and Perl Compatible Regular Expressions  (PCREs) with some restrictions. Reference http://www.pcre .org for  PCRE and the NSX-T Administrator's Guide for the restrictions.  Please note, when regular expressions are used in JSON (JavaScript  Object Notation) string, every backslash character (\\) needs to be  escaped by one additional backslash character.", 
      "required": false, 
      "title": "HTTP request uri match condition", 
      "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 PolicyLbRules associated with a single PolicyLbVirtualServer and will be applied numerically or low to high", 
      "required": false, 
      "title": "Sequence number of the this PolicyLbRule", 
      "type": "int"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Binding of a LbPoolAccess and Group to a PolicyLbVirtualServer", 
  "type": "object"
}

PolicyLbVirtualServer (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "description": "All the types of PolicyLbVirtualServer extend from this abstract class. This is present for extensibility.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "PolicyLbVirtualServer", 
  "module_id": "TempPolicyLoadBalancer", 
  "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: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "access_log_enabled": {
      "default": false, 
      "description": "If access log is enabled, all HTTP requests sent to an L7 virtual server are logged to the access log file. Both successful requests (backend server returns 2xx) and unsuccessful requests (backend server returns 4xx or 5xx) are logged to access log, if enabled.", 
      "required": false, 
      "title": "Access log enabled setting", 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ip_address": {
      "$ref": "IPAddress, 
      "description": "Configures the IP address of the PolicyLbVirtualServer where it receives all client connections and distributes them among the backend servers.", 
      "required": true, 
      "title": "IP address of the PolicyLbVirtualServer"
    }, 
    "lb_persistence_profile": {
      "description": "Path to optional object that enables persistence on a virtual server allowing related client connections to be sent to the same backend server. Persistence is disabled by default.", 
      "required": false, 
      "title": "Persistence Profile used by PolicyLbVirtualServer", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "ports": {
      "description": "Ports contains a list of at least one port or port range such as \"80\", \"1234-1236\". Each port element in the list should be a single port or a single port range.", 
      "items": {
        "$ref": "PortElement
      }, 
      "required": true, 
      "title": "Virtual server port number(s) or port range(s)", 
      "type": "array"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "enum": [
        "TcpPolicyLbVirtualServer", 
        "UdpPolicyLbVirtualServer", 
        "HttpPolicyLbVirtualServer", 
        "HttpsPolicyLbVirtualServer", 
        "CustomPolicyLbVirtualServer"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "router_path": {
      "description": "Path to router type object that PolicyLbVirtualServer connects to. The only supported router object is Network.", 
      "required": true, 
      "title": "Path to router type object for PolicyLbVirtualServer", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "traffic_source": {
      "type": "string"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Base class for each type of PolicyLbVirtualServer", 
  "type": "object"
}

PolicyListL2TablesParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListByNodeIdParameters
  }, 
  "id": "PolicyListL2TablesParameters", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "enforcement_point_path": {
      "description": "Enforcement point path.", 
      "title": "String Path of the enforcement point", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "source": {
      "$ref": "DataSourceType, 
      "required": false, 
      "title": "The data source, either realtime or cached. If not provided, cached data is returned."
    }, 
    "transport_node_id": {
      "required": false, 
      "title": "TransportNode Id", 
      "type": "string"
    }
  }, 
  "title": "Layer-2 table list request parameters", 
  "type": "object"
}

PolicyListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "PolicyListRequestParameters", 
  "module_id": "Policy", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Policy list request parameters", 
  "type": "object"
}

PolicyListResult (type)

{
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "PolicyListResult", 
  "module_id": "Policy", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of security policies", 
  "type": "object"
}

PolicyLiveTraceActionConfig (type)

{
  "additionalProperties": false, 
  "id": "PolicyLiveTraceActionConfig", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "count_config": {
      "$ref": "CountActionConfig, 
      "required": false, 
      "title": "Configuration of count action"
    }, 
    "pktcap_config": {
      "$ref": "LiveTracePacketGranularActionConfig, 
      "required": false, 
      "title": "Configuration of packet capture action"
    }, 
    "trace_config": {
      "$ref": "LiveTracePacketGranularActionConfig, 
      "required": false, 
      "title": "Configuration of trace action"
    }
  }, 
  "title": "Livetrace action configuration", 
  "type": "object"
}

PolicyMulticastConfig (type)

{
  "additionalProperties": false, 
  "description": "Multicast routing configuration.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "PolicyMulticastConfig", 
  "module_id": "PolicyMulticast", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "enabled": {
      "default": false, 
      "description": "Enable/disable Multicast Configuration.", 
      "required": false, 
      "title": "Enable/disable Multicast Configuration", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "igmp_profile_path": {
      "description": "Updates to IGMP profile applied on all Tier0 gateways consuming the configuration.", 
      "required": false, 
      "title": "Policy path to IGMP profile", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "pim_profile_path": {
      "description": "Updates to PIM profile applied on all Tier0 gateways consuming the configuration.", 
      "required": false, 
      "title": "Policy path to PIM profile", 
      "type": "string"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "replication_multicast_range": {
      "description": "Replication multicast range. Required when enabled.", 
      "format": "ipv4-cidr-block", 
      "required": false, 
      "title": "Replication multicast range", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Multicast routing configuration", 
  "type": "object"
}

PolicyNATRuleCounters (type)

{
  "additionalProperties": false, 
  "description": "Gives the statistics count of a NAT rule.", 
  "id": "PolicyNATRuleCounters", 
  "module_id": "PolicyNAT", 
  "properties": {
    "active_sessions": {
      "description": "Gives the total number of active sessions.", 
      "readonly": true, 
      "title": "Active sessions", 
      "type": "integer"
    }, 
    "total_bytes": {
      "description": "Gives the total number of bytes.", 
      "readonly": true, 
      "title": "Total bytes", 
      "type": "integer"
    }, 
    "total_packets": {
      "description": "Gives the total number of packets.", 
      "readonly": true, 
      "title": "Total packets", 
      "type": "integer"
    }
  }, 
  "title": "Statistics count", 
  "type": "object"
}

PolicyNat (type)

{
  "additionalProperties": false, 
  "description": "Represents NAT section. This object is created by default when corresponding tier-0/tier-1 is created. Under tier-0/tier-1 there will be 4 different NATs(sections). (INTERNAL, USER, DEFAULT and NAT64).", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "PolicyNat", 
  "module_id": "PolicyNAT", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "nat_type": {
      "description": "Represents a NAT section under tier-0/tier-1.", 
      "enum": [
        "INTERNAL", 
        "USER", 
        "DEFAULT", 
        "NAT64"
      ], 
      "title": "NAT section under tier-0/tier-1", 
      "type": "string"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Contains list of NAT Rules", 
  "type": "object"
}

PolicyNatRule (type)

{
  "additionalProperties": false, 
  "description": "Represents a NAT rule between source and destination at T0/T1 router.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "PolicyNatRule", 
  "module_id": "PolicyNAT", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "action": {
      "description": "Source NAT(SNAT) - translates a source IP address in an outbound packet so that the packet appears to originate from a different network. SNAT is only supported when the logical router is running in active-standby mode. Destination NAT(DNAT) - translates the destination IP address of inbound packets so that packets are delivered to a target address into another network. DNAT is only supported when the logical router is running in active-standby mode. Reflexive NAT(REFLEXIVE) - IP-Range and CIDR are supported to define the \"n\". The number of original networks should be exactly the same as that of translated networks. The address translation is deterministic. Reflexive is supported on both Active/Standby and Active/Active LR. NO_SNAT and NO_DNAT - These do not have support for translated_fields, only source_network and destination_network fields are supported. NAT64 - translates an external IPv6 address to a internal IPv4 address.", 
      "enum": [
        "SNAT", 
        "DNAT", 
        "REFLEXIVE", 
        "NO_SNAT", 
        "NO_DNAT", 
        "NAT64"
      ], 
      "required": true, 
      "title": "Represents action of NAT Rule SNAT, DNAT, REFLEXIVE", 
      "type": "string"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "destination_network": {
      "$ref": "IPElementList, 
      "description": "This supports single IP address or comma separated list of single IP addresses or CIDR. This does not support IP range or IP sets. For DNAT and NO_DNAT rules, this is a mandatory field, and represents the destination network for the incoming packets. For other type of rules, optionally it can contain destination network of outgoing packets. NULL value for this field represents ANY network.", 
      "required": false, 
      "title": "Represents the destination network"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "enabled": {
      "default": true, 
      "description": "The flag, which suggests whether the NAT rule is enabled or disabled. The default is True.", 
      "title": "Policy NAT Rule enabled flag", 
      "type": "boolean"
    }, 
    "firewall_match": {
      "default": "MATCH_INTERNAL_ADDRESS", 
      "description": "It indicates how the firewall matches the address after NATing if firewall stage is not skipped.  MATCH_EXTERNAL_ADDRESS indicates the firewall will be applied to external address of a NAT rule. For SNAT, the external address is the translated source address after NAT is done. For DNAT, the external address is the original destination address before NAT is done. For REFLEXIVE, to egress traffic, the firewall will be applied to the translated source address after NAT is done; To ingress traffic, the firewall will be applied to the original destination address before NAT is done.  MATCH_INTERNAL_ADDRESS indicates the firewall will be applied to internal address of a NAT rule. For SNAT, the internal address is the original source address before NAT is done. For DNAT, the internal address is the translated destination address after NAT is done. For REFLEXIVE, to egress traffic, the firewall will be applied to the original source address before NAT is done; To ingress traffic, the firewall will be applied to the translated destination address after NAT is done.  BYPASS indicates the firewall stage will be skipped.  For NO_SNAT or NO_DNAT, it must be BYPASS or leave it unassigned", 
      "enum": [
        "MATCH_EXTERNAL_ADDRESS", 
        "MATCH_INTERNAL_ADDRESS", 
        "BYPASS"
      ], 
      "required": false, 
      "title": "Represents the firewall match flag", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "logging": {
      "default": false, 
      "description": "The flag, which suggests whether the logging of NAT rule is enabled or disabled. The default is False.", 
      "title": "Policy NAT Rule logging flag", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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"
    }, 
    "scope": {
      "description": "Represents the array of policy paths of ProviderInterface or NetworkInterface or labels of type ProviderInterface or NetworkInterface on which the NAT rule should get enforced. The interfaces must belong to the same router for which the NAT Rule is created.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Array of policy paths of labels, ProviderInterface, NetworkInterface", 
      "type": "array"
    }, 
    "sequence_number": {
      "default": 0, 
      "description": "The sequence_number decides the rule_priority of a NAT rule. Sequence_number and rule_priority have 1:1 mapping.For each NAT section, there will be reserved rule_priority numbers.The valid range of rule_priority number is from 0 to 2147483647(MAX_INT). 1. INTERNAL section     rule_priority reserved from 0 - 1023 (1024 rules)     valid sequence_number range  0 - 1023 2. USER section    rule_priority reserved from 1024 - 2147482623 (2147481600 rules)    valid sequence_number range  0 - 2147481599 3. DEFAULT section    rule_priority reserved from 2147482624 - 2147483647 (1024 rules)    valid sequence_number range  0 - 1023", 
      "title": "Sequence number of the Nat Rule", 
      "type": "int"
    }, 
    "service": {
      "description": "It represents the path of Service on which the NAT rule will be applied. If not provided or if it is blank then Policy manager will consider it as ANY. Please note, if this is a DNAT, the destination_port of the service will be realized on NSX Manager as the translated_port. And if this is a SNAT, the destination_port will be ignored.", 
      "required": false, 
      "title": "Represents the service on which the NAT rule will be applied", 
      "type": "string"
    }, 
    "source_network": {
      "$ref": "IPElementList, 
      "description": "This supports single IP address or comma separated list of single IP addresses or CIDR. This does not support IP range or IP sets. For SNAT, NO_SNAT, NAT64 and REFLEXIVE rules, this is a mandatory field and represents the source network of the packets leaving the network. For DNAT and NO_DNAT rules, optionally it can contain source network of incoming packets. NULL value for this field represents ANY network.", 
      "required": false, 
      "title": "Represents the source network address"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "translated_network": {
      "$ref": "IPElementList, 
      "description": "This supports single IP address or comma separated list of single IP addresses or CIDR. This does not support IP range or IP sets. For SNAT, DNAT, NAT64 and REFLEXIVE rules, this ia a mandatory field, which represents the translated network address. For NO_SNAT and NO_DNAT this should be empty.", 
      "required": false, 
      "title": "Represents the translated network address"
    }, 
    "translated_ports": {
      "$ref": "PortElement, 
      "description": "Please note, if there is service configured in this NAT rule, the translated_port will be realized on NSX Manager as the destination_port. If there is no sevice configured, the port will be ignored.", 
      "required": false, 
      "title": "Port number or port range"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Represents a NAT rule between source and destination at T0/T1 router", 
  "type": "object"
}

PolicyNatRuleListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "PolicyNatRuleListRequestParameters", 
  "module_id": "PolicyNAT", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "NAT Rule list request parameters", 
  "type": "object"
}

PolicyNatRuleListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "PolicyNatRuleListResult", 
  "module_id": "PolicyNAT", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "PolicyNatRule
      }, 
      "required": true, 
      "title": "NAT Rules list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of NAT Rules", 
  "type": "object"
}

PolicyNatRuleStatistics (type)

{
  "additionalProperties": false, 
  "description": "Gives the Statistics of a NAT rule.", 
  "extends": {
    "$ref": "PolicyNATRuleCounters
  }, 
  "id": "PolicyNatRuleStatistics", 
  "module_id": "PolicyNAT", 
  "properties": {
    "active_sessions": {
      "description": "Gives the total number of active sessions.", 
      "readonly": true, 
      "title": "Active sessions", 
      "type": "integer"
    }, 
    "last_update_timestamp": {
      "$ref": "EpochMsTimestamp, 
      "description": "Timestamp when the data was last updated.", 
      "readonly": true, 
      "title": "Last update timestamp"
    }, 
    "total_bytes": {
      "description": "Gives the total number of bytes.", 
      "readonly": true, 
      "title": "Total bytes", 
      "type": "integer"
    }, 
    "total_packets": {
      "description": "Gives the total number of packets.", 
      "readonly": true, 
      "title": "Total packets", 
      "type": "integer"
    }, 
    "warning_message": {
      "description": "The warning message about the NAT Rule Statistics.", 
      "readonly": true, 
      "title": "Warning Message", 
      "type": "string"
    }
  }, 
  "title": "Statistics of NAT Rule", 
  "type": "object"
}

PolicyNatRuleStatisticsListRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "Request parameter to get NAT rule statistics.", 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "PolicyNatRuleStatisticsListRequestParameters", 
  "module_id": "PolicyNAT", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "enforcement_point_path": {
      "description": "Enforcement point path, forward slashes must be escaped using %2F.", 
      "required": false, 
      "title": "String Path of the enforcement point", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "NAT Rule statistics list request parameters", 
  "type": "object"
}

PolicyNatRuleStatisticsListResult (type)

{
  "additionalProperties": false, 
  "description": "Gives the collection of NAT rule statistics per enforcement point.", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "PolicyNatRuleStatisticsListResult", 
  "module_id": "PolicyNAT", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "PolicyNatRuleStatisticsPerEnforcementPoint
      }, 
      "required": true, 
      "title": "NAT rules statistics per enforcement point", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Collection of NAT Rule statistics", 
  "type": "object"
}

PolicyNatRuleStatisticsPerEnforcementPoint (type)

{
  "additionalProperties": false, 
  "description": "Gives the statistics of a NAT rule per enforcement point.", 
  "id": "PolicyNatRuleStatisticsPerEnforcementPoint", 
  "module_id": "PolicyNAT", 
  "properties": {
    "enforcement_point_path": {
      "description": "Policy Path referencing the enforcement point from where the statistics are fetched.", 
      "title": "Enforcement point Path", 
      "type": "string"
    }, 
    "rule_path": {
      "description": "Path of NAT Rule.", 
      "title": "Path of NAT Rule", 
      "type": "string"
    }, 
    "rule_statistics": {
      "description": "Gives NAT rule stats on an enforcement point.", 
      "items": {
        "$ref": "PolicyNatRuleStatistics
      }, 
      "readonly": true, 
      "title": "Rule statistics per enforcement point", 
      "type": "array"
    }
  }, 
  "title": "Statistics of NAT Rule per enforcement point", 
  "type": "object"
}

PolicyNatRuleStatisticsPerLogicalRouter (type)

{
  "additionalProperties": false, 
  "description": "Gives the statistics of a NAT rule per logical router on specified enforcement point.", 
  "id": "PolicyNatRuleStatisticsPerLogicalRouter", 
  "module_id": "PolicyNAT", 
  "properties": {
    "enforcement_point_path": {
      "description": "Policy Path referencing the enforcement point from where the statistics are fetched.", 
      "title": "Enforcement point Path", 
      "type": "string"
    }, 
    "last_update_timestamp": {
      "$ref": "EpochMsTimestamp, 
      "description": "Timestamp when the data was last updated.", 
      "readonly": true, 
      "title": "Last update timestamp"
    }, 
    "per_node_statistics": {
      "description": "Detailed Rule statistics per logical router.", 
      "items": {
        "$ref": "PolicyNatRuleStatisticsPerTransportNode
      }, 
      "readonly": true, 
      "title": "Detailed Rule statistics", 
      "type": "array"
    }, 
    "router_path": {
      "description": "Path of the router.", 
      "title": "Router path", 
      "type": "string"
    }, 
    "statistics": {
      "$ref": "PolicyNATRuleCounters, 
      "description": "Rolled up statistics for all rules on the logical router.", 
      "readonly": true, 
      "title": "Rolled up statistics"
    }
  }, 
  "title": "Statistics of NAT Rule per logical router", 
  "type": "object"
}

PolicyNatRuleStatisticsPerLogicalRouterListResult (type)

{
  "additionalProperties": false, 
  "description": "Gives the collection of NAT rule statistics per logical router on specified enforcement point.", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "PolicyNatRuleStatisticsPerLogicalRouterListResult", 
  "module_id": "PolicyNAT", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "PolicyNatRuleStatisticsPerLogicalRouter
      }, 
      "required": true, 
      "title": "NAT rules statistics per logical router", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Collection of NAT rule statistics per logical router", 
  "type": "object"
}

PolicyNatRuleStatisticsPerTransportNode (type)

{
  "additionalProperties": false, 
  "description": "Gives the Statistics of a NAT rule.", 
  "extends": {
    "$ref": "PolicyNATRuleCounters
  }, 
  "id": "PolicyNatRuleStatisticsPerTransportNode", 
  "module_id": "PolicyNAT", 
  "properties": {
    "active_sessions": {
      "description": "Gives the total number of active sessions.", 
      "readonly": true, 
      "title": "Active sessions", 
      "type": "integer"
    }, 
    "last_update_timestamp": {
      "$ref": "EpochMsTimestamp, 
      "description": "Timestamp when the data was last updated.", 
      "readonly": true, 
      "title": "Last update timestamp"
    }, 
    "total_bytes": {
      "description": "Gives the total number of bytes.", 
      "readonly": true, 
      "title": "Total bytes", 
      "type": "integer"
    }, 
    "total_packets": {
      "description": "Gives the total number of packets.", 
      "readonly": true, 
      "title": "Total packets", 
      "type": "integer"
    }, 
    "transport_node_path": {
      "description": "Policy path of the Edge Node.", 
      "readonly": true, 
      "title": "Node path", 
      "type": "string"
    }
  }, 
  "title": "Statistics of NAT Rule", 
  "type": "object"
}

PolicyNonCompliantConfig (type)

{
  "id": "PolicyNonCompliantConfig", 
  "module_id": "PolicyCompliance", 
  "properties": {
    "affected_resources": {
      "description": "Resources/Services impacted by non compliant configuration", 
      "items": {
        "$ref": "PolicyResourceReference
      }, 
      "readonly": true, 
      "title": "Resources/Services impacted by non compliant configuration", 
      "type": "array"
    }, 
    "description": {
      "readonly": true, 
      "title": "Detail description of non compliant configuration with suggestive action", 
      "type": "string"
    }, 
    "non_compliance_code": {
      "readonly": true, 
      "title": "Code for non compliant configuration", 
      "type": "integer"
    }, 
    "reported_by": {
      "$ref": "PolicyResourceReference, 
      "readonly": true, 
      "title": "Id and name of non compliant resource/service"
    }
  }, 
  "type": "object"
}

PolicyNsLookupParameters (type)

{
  "extends": {
    "$ref": "PolicyRuntimeOnEpRequestParameters
  }, 
  "id": "PolicyNsLookupParameters", 
  "module_id": "PolicyDnsForwarder", 
  "properties": {
    "address": {
      "required": false, 
      "title": "IP address or FQDN for nslookup", 
      "type": "string"
    }, 
    "enforcement_point_path": {
      "description": "enforcement point path, forward slashes must be escaped using %2F.", 
      "required": false, 
      "title": "String Path of the enforcement point", 
      "type": "string"
    }
  }, 
  "type": "object"
}

PolicyPimProfile (type)

{
  "additionalProperties": false, 
  "description": "PIM profile.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "PolicyPimProfile", 
  "module_id": "PolicyMulticast", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "bsm_enabled": {
      "default": true, 
      "description": "Enable/disable bootstrap messaging Configuration.", 
      "required": false, 
      "title": "Enable/disable bootstrap messaging Configuration", 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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"
    }, 
    "rp_address": {
      "$ref": "IPAddress, 
      "description": "Static IPv4 multicast address configuration.", 
      "required": false, 
      "title": "Static IPv4 multicast address configuration"
    }, 
    "rp_address_multicast_ranges": {
      "description": "Static IPv4 multicast address and assciated multicast groups configuration.", 
      "items": {
        "$ref": "RpAddressMulticastRanges
      }, 
      "required": false, 
      "title": "Static IPv4 multicast address and assciated multicast groups configuration", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "PIM profile", 
  "type": "object"
}

PolicyRealizedResource (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "description": "Abstract base class for all the realized policy objects", 
  "extends": {
    "$ref": "PolicyResource
  }, 
  "id": "PolicyRealizedResource", 
  "module_id": "PolicyRealizedState", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "intent_reference": {
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Desire state paths of this object", 
      "type": "array"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "realization_api": {
      "required": false, 
      "title": "Realization API of this object on enforcement point", 
      "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"
    }, 
    "runtime_error": {
      "description": "It define the root cause for runtime error.", 
      "required": false, 
      "title": "String representation of runtime error", 
      "type": "string"
    }, 
    "runtime_status": {
      "description": "Possible values could be UP, DOWN, UNKNOWN, DEGRADED This list is not exhaustive.", 
      "required": false, 
      "title": "String representation of runtime status", 
      "type": "string"
    }, 
    "state": {
      "enum": [
        "UNAVAILABLE", 
        "UNREALIZED", 
        "REALIZED", 
        "ERROR"
      ], 
      "required": true, 
      "title": "Realization state of this object", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Abstract base class for all the realized policy objects", 
  "type": "object"
}

PolicyRelatedApiError (type)

{
  "id": "PolicyRelatedApiError", 
  "module_id": "PolicyRealizedState", 
  "properties": {
    "details": {
      "title": "Further details about the error", 
      "type": "string"
    }, 
    "error_code": {
      "title": "A numeric error code", 
      "type": "integer"
    }, 
    "error_data": {
      "title": "Additional data about the error", 
      "type": "object"
    }, 
    "error_message": {
      "title": "A description of the error", 
      "type": "string"
    }, 
    "module_name": {
      "title": "The module name where the error occurred", 
      "type": "string"
    }
  }, 
  "title": "Detailed information about errors from API call to an enforcement point", 
  "type": "object"
}

PolicyResource (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "description": "Abstract base class for all the policy objects.", 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "PolicyResource", 
  "module_id": "Policy", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Abstract base class for all the policy objects", 
  "type": "object"
}

PolicyResourceReference (type)

{
  "additionalProperties": false, 
  "description": "Policy resource reference.", 
  "extends": {
    "$ref": "ResourceReference
  }, 
  "id": "PolicyResourceReference", 
  "module_id": "Policy", 
  "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"
    }, 
    "path": {
      "description": "Absolute path of this object.", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "target_display_name": {
      "description": "Display name of the NSX resource.", 
      "maxLength": 255, 
      "readonly": true, 
      "required": false, 
      "title": "Target display name", 
      "type": "string"
    }, 
    "target_id": {
      "description": "Identifier of the NSX resource.", 
      "maxLength": 64, 
      "readonly": false, 
      "required": false, 
      "title": "Target ID", 
      "type": "string"
    }, 
    "target_type": {
      "description": "Type of the NSX resource.", 
      "maxLength": 255, 
      "readonly": false, 
      "required": false, 
      "title": "Target type", 
      "type": "string"
    }
  }, 
  "title": "Policy resource reference", 
  "type": "object"
}

PolicyResourceReferenceForEP (type)

{
  "additionalProperties": false, 
  "description": "Policy resource reference for enforcement point", 
  "extends": {
    "$ref": "PolicyResourceReference
  }, 
  "id": "PolicyResourceReferenceForEP", 
  "module_id": "PolicyGroupRealization", 
  "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"
    }, 
    "path": {
      "description": "Absolute path of this object.", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "target_display_name": {
      "description": "Display name of the NSX resource.", 
      "maxLength": 255, 
      "readonly": true, 
      "required": false, 
      "title": "Target display name", 
      "type": "string"
    }, 
    "target_id": {
      "description": "Identifier of the NSX resource.", 
      "maxLength": 64, 
      "readonly": false, 
      "required": false, 
      "title": "Target ID", 
      "type": "string"
    }, 
    "target_type": {
      "description": "Type of the NSX resource.", 
      "maxLength": 255, 
      "readonly": false, 
      "required": false, 
      "title": "Target type", 
      "type": "string"
    }
  }, 
  "title": "Policy resource reference for enforcement point", 
  "type": "object"
}

PolicyResourceReferenceForEPListResult (type)

{
  "additionalProperties": false, 
  "description": "Paginated collection of policy resource references for enforcement point", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "PolicyResourceReferenceForEPListResult", 
  "module_id": "PolicyGroupRealization", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "PolicyResourceReferenceForEP
      }, 
      "required": true, 
      "title": "Paged Collection of policy resource references for enforcement point", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Policy resource reference list for enforcement point", 
  "type": "object"
}

PolicyResourceReferenceListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "PolicyResourceReferenceListResult", 
  "module_id": "Policy", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "PolicyResourceReference
      }, 
      "required": true, 
      "title": "Policy resource references list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of PolicyResourceReference", 
  "type": "object"
}

PolicyRuntimeAlarm (type)

{
  "description": "Alarm associated with the PolicyRuntimeInfoPerEP that exposes potential errors when retrieving runtime information from the enforcement point.", 
  "id": "PolicyRuntimeAlarm", 
  "module_id": "PolicyBaseStatistics", 
  "properties": {
    "error_details": {
      "$ref": "PolicyApiError, 
      "description": "Detailed information about errors from an API call made to the enforcement point, if any.", 
      "readonly": true, 
      "title": "Error Detailed Information"
    }, 
    "error_id": {
      "description": "Alarm error id.", 
      "readonly": true, 
      "title": "Alarm Error Id", 
      "type": "string"
    }, 
    "message": {
      "description": "Error message describing the issue.", 
      "readonly": true, 
      "title": "Error Message to Describe the Issue", 
      "type": "string"
    }
  }, 
  "title": "Alarm of PolicyRuntimeInfoPerEP", 
  "type": "object"
}

PolicyRuntimeInfoPerEP (type)

{
  "abstract": true, 
  "description": "Runtime Info Per Enforcement Point.", 
  "id": "PolicyRuntimeInfoPerEP", 
  "module_id": "PolicyBaseStatistics", 
  "properties": {
    "alarm": {
      "$ref": "PolicyRuntimeAlarm, 
      "description": "Alarm information details.", 
      "readonly": true, 
      "title": "Alarm Information Details"
    }, 
    "enforcement_point_path": {
      "description": "Policy Path referencing the enforcement point where the info is fetched.", 
      "readonly": true, 
      "title": "Enforcement point Path", 
      "type": "string"
    }
  }, 
  "title": "PolicyRuntimeInfoPerEP", 
  "type": "object"
}

PolicyRuntimeOnEpRequestParameters (type)

{
  "description": "Request parameters that represents an enforcement point path. A request on runtime information can be parameterized with this path and will be evaluated as follows: - no enforcement point path specified: the request is evaluated on all enforcement points. - an enforcement point path is specified: the request is evaluated only on the given enforcement point.", 
  "id": "PolicyRuntimeOnEpRequestParameters", 
  "module_id": "PolicyBaseStatistics", 
  "properties": {
    "enforcement_point_path": {
      "description": "enforcement point path, forward slashes must be escaped using %2F.", 
      "required": false, 
      "title": "String Path of the enforcement point", 
      "type": "string"
    }
  }, 
  "title": "Request Parameters for Policy Runtime on enforcement point", 
  "type": "object"
}

PolicyRuntimeRequestParameters (type)

{
  "description": "Request parameters that represents an enforcement point path and data source. A request on runtime information can be parameterized with this pair and will be evaluted as follows: - no enforcement point path specified: the request is evaluated on all enforcement points. - an enforcement point path is specified: the request is evaluated only on the given enforcement point.", 
  "extends": {
    "$ref": "DataSourceParameters
  }, 
  "id": "PolicyRuntimeRequestParameters", 
  "module_id": "PolicyBaseStatistics", 
  "properties": {
    "enforcement_point_path": {
      "description": "enforcement point path, forward slashes must be escaped using %2F.", 
      "required": false, 
      "title": "String Path of the enforcement point", 
      "type": "string"
    }, 
    "source": {
      "$ref": "DataSourceType, 
      "required": false, 
      "title": "The data source, either realtime or cached. If not provided, cached data is returned."
    }
  }, 
  "title": "Request Parameters for Policy Runtime Information", 
  "type": "object"
}

PolicySIExcludeList (type)

{
  "additionalProperties": false, 
  "description": "List of entities where Service Insertion will not be enforced. Exclusion List can contain PolicyGroup(s) or SegmentPort(s) or Segment(s).", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "PolicySIExcludeList", 
  "module_id": "PolicyServiceInsertion", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "members": {
      "description": "List of the members in the exclude list", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 100, 
      "required": true, 
      "title": "ExcludeList member list", 
      "type": "array"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Service Insertion Exclusion List", 
  "type": "object"
}

PolicySIStatusConfiguration (type)

{
  "description": "It represents status of Service Insertion for North-South and East-West context types.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "PolicySIStatusConfiguration", 
  "module_id": "PolicyServiceInsertion", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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"
    }, 
    "east_west_enabled": {
      "default": false, 
      "description": "If set to true, service insertion for east-west traffic is enabled.", 
      "title": "East-West status flag", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "north_south_enabled": {
      "default": false, 
      "description": "If set to true, service insertion for north-south traffic is enabled.", 
      "title": "North-South status flag", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Service Insertion Status", 
  "type": "object"
}

PolicyServiceChain (type)

{
  "description": "Service chain is a set of network Services. A Service chain is made up of ordered list of service profiles belonging to any same or different services.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "PolicyServiceChain", 
  "module_id": "PolicyServiceInsertion", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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"
    }, 
    "failure_policy": {
      "default": "ALLOW", 
      "description": "Failure policy for the service defines the action to be taken i.e to allow or to block the traffic during failure scenarios.", 
      "enum": [
        "ALLOW", 
        "BLOCK"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "Failure Policy", 
      "type": "string"
    }, 
    "forward_path_service_profiles": {
      "description": "Forward path service profiles are applied to ingress traffic.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 4, 
      "readonly": false, 
      "required": true, 
      "title": "Forward path service profiles", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "path_selection_policy": {
      "default": "ANY", 
      "description": "Path selection policy can be - ANY - Service Insertion is free to redirect to any service path regardless of any load balancing considerations or flow pinning. LOCAL - Preference to be given to local service insances. REMOTE - Preference to be given to the SVM co-located on the same host. ROUND_ROBIN - All active service paths are hit with equal probability.", 
      "enum": [
        "ANY", 
        "LOCAL", 
        "REMOTE", 
        "ROUND_ROBIN"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "Path Selection Policy", 
      "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"
    }, 
    "reverse_path_service_profiles": {
      "description": "Reverse path service profiles are applied to egress traffic and is optional. 2 different set of profiles can be defined for forward and reverse path. If not defined, the reverse of the forward path service profile is applied.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 4, 
      "readonly": false, 
      "required": false, 
      "title": "Reverse path service profiles", 
      "type": "array"
    }, 
    "service_segment_path": {
      "description": "Path to service segment using which the traffic needs to be redirected.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 1, 
      "minItems": 1, 
      "readonly": false, 
      "required": true, 
      "title": "Path to service segment", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Policy Service Chain", 
  "type": "object"
}

PolicyServiceInstance (type)

{
  "additionalProperties": false, 
  "description": "Represents an instance of partner Service and its configuration.", 
  "extends": {
    "$ref": "BasePolicyServiceInstance
  }, 
  "id": "PolicyServiceInstance", 
  "module_id": "PolicyServiceInsertion", 
  "polymorphic-type-descriptor": {
    "type-identifier": "PolicyServiceInstance"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "attributes": {
      "description": "List of attributes specific to a partner for which the service is created. There attributes are passed on to the partner appliance.", 
      "items": {
        "$ref": "Attribute
      }, 
      "maxItems": 128, 
      "required": true, 
      "title": "Deployment Template attributes", 
      "type": "array"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "compute_id": {
      "description": "Id of the compute(ResourcePool) to which this service needs to be deployed.", 
      "required": true, 
      "title": "Id of the compute resource.", 
      "type": "string"
    }, 
    "context_id": {
      "description": "UUID of VCenter/Compute Manager as seen on NSX Manager, to which this service needs to be deployed.", 
      "required": false, 
      "title": "Id of the compute manager", 
      "type": "string"
    }, 
    "deployment_mode": {
      "default": "ACTIVE_STANDBY", 
      "description": "Deployment mode specifies how the partner appliance will be deployed i.e. in HA or standalone mode.", 
      "enum": [
        "STAND_ALONE", 
        "ACTIVE_STANDBY"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "Deployment Mode", 
      "type": "string"
    }, 
    "deployment_spec_name": {
      "description": "Form factor for the deployment of partner service.", 
      "required": true, 
      "title": "Name of the Deployment Specification", 
      "type": "string"
    }, 
    "deployment_template_name": {
      "description": "Template for the deployment of partnet service.", 
      "required": true, 
      "title": "Name of the Deployment Template", 
      "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"
    }, 
    "failure_policy": {
      "default": "BLOCK", 
      "description": "Failure policy for the Service VM. If this values is not provided, it will be defaulted to FAIL_CLOSE.", 
      "enum": [
        "ALLOW", 
        "BLOCK"
      ], 
      "required": false, 
      "title": "Failure policy for the Service VM", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "partner_service_name": {
      "description": "Unique name of Partner Service in the Marketplace", 
      "required": true, 
      "title": "Name of Partner Service", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "primary_gateway_address": {
      "$ref": "IPElement, 
      "description": "Gateway address for primary management console. If the provided segment already has gateway, this field can be omitted. But if it is provided, it takes precedence always. However, if provided segment does not have gateway, this field must be provided.", 
      "required": false, 
      "title": "Gateway for primary management console"
    }, 
    "primary_interface_mgmt_ip": {
      "$ref": "IPElement, 
      "description": "Management IP Address of primary interface of the Service", 
      "required": true, 
      "title": "Management IP Address of primary interface of the Service"
    }, 
    "primary_interface_network": {
      "description": "Path of the segment to which primary interface of the Service VM needs to be connected", 
      "required": false, 
      "title": "Path of the segment to which primary interface of the Service VM needs to be connected", 
      "type": "string"
    }, 
    "primary_portgroup_id": {
      "description": "Id of the standard or ditsributed port group for primary management console. Please note that only 1 of the 2 values from 1. primary_interface_network 2. primary_portgroup_id are allowed to be passed. Both can't be passed in the same request.", 
      "required": false, 
      "title": "Id of the standard or ditsributed port group for primary management console", 
      "type": "string"
    }, 
    "primary_subnet_mask": {
      "$ref": "IPElement, 
      "description": "Subnet for primary management console IP. If the provided segment already has subnet, this field can be omitted. But if it is provided, it takes precedence always. However, if provided segment does not have subnet, this field must be provided.", 
      "required": false, 
      "title": "Subnet for primary management console IP"
    }, 
    "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"
    }, 
    "secondary_gateway_address": {
      "$ref": "IPElement, 
      "description": "Gateway address for secondary management console. If the provided segment already has gateway, this field can be omitted. But if it is provided, it takes precedence always. However, if provided segment does not have gateway, this field must be provided.", 
      "required": false, 
      "title": "Gateway for secondary management console"
    }, 
    "secondary_interface_mgmt_ip": {
      "$ref": "IPElement, 
      "description": "Management IP Address of secondary interface of the Service", 
      "required": false, 
      "title": "Management IP Address of secondary interface of the Service"
    }, 
    "secondary_interface_network": {
      "description": "Path of segment to which secondary interface of the Service VM needs to be connected", 
      "required": false, 
      "title": "Path of segment to which secondary interface of the Service VM needs to be connected", 
      "type": "string"
    }, 
    "secondary_portgroup_id": {
      "description": "Id of the standard or ditsributed port group for secondary management console. Please note that only 1 of the 2 values from 1. secondary_interface_network 2. secondary_portgroup_id are allowed to be passed. Both can't be passed in the same request.", 
      "required": false, 
      "title": "Id of the standard or ditsributed port group for secondary management console", 
      "type": "string"
    }, 
    "secondary_subnet_mask": {
      "$ref": "IPElement, 
      "description": "Subnet for secondary management console IP. If the provided segment already has subnet, this field can be omitted. But if it is provided, it takes precedence always. However, if provided segment does not have subnet, this field must be provided.", 
      "required": false, 
      "title": "Subnet for secondary management console IP"
    }, 
    "storage_id": {
      "description": "Id of the storage(Datastore). VC moref of Datastore to which this service needs to be deployed.", 
      "required": true, 
      "title": "Id of the storage", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "transport_type": {
      "default": "L2_BRIDGE", 
      "description": "Transport to be used while deploying Service-VM.", 
      "enum": [
        "L2_BRIDGE", 
        "L3_ROUTED"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "Transport Type", 
      "type": "string"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Represents an instance of partner Service and its configuration", 
  "type": "object"
}

PolicyServiceProfile (type)

{
  "description": "Service profile represents specialization of a vendor template. User may provide any of the vendor_template_name or vendor_template_key properties. But in case of multiple vendor templates with the same name, it is recommended to use the vendor_template_key. When both attributes are provided, name is ignored and only key is used to identify the template. If there are multiple templates with same name, and vendor_template_name is provided, realization will fail.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "PolicyServiceProfile", 
  "module_id": "PolicyServiceInsertion", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "attributes": {
      "description": "List of attributes specific to a partner for which the service is created. These attributes are passed on to the partner appliance and are opaque to NSX. If a vendor template exposes configurable parameters, then their values are specified here.", 
      "items": {
        "$ref": "Attribute
      }, 
      "maxItems": 128, 
      "readonly": false, 
      "required": false, 
      "title": "Service profile attributes", 
      "type": "array"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "redirection_action": {
      "description": "The redirection action represents if the packet is exclusively redirected to the service, or if a copy is forwarded to the service. Redirection action is not applicable to guest introspection service.", 
      "enum": [
        "PUNT", 
        "COPY"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "Redirection action", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }, 
    "vendor_template_key": {
      "description": "The vendor template key property of actual vendor template. This should be used when multiple templates with same name exist.", 
      "required": false, 
      "title": "Vendor Template Key", 
      "type": "string"
    }, 
    "vendor_template_name": {
      "description": "Name of the vendor template for which this Service Profile is being created.", 
      "readonly": false, 
      "required": false, 
      "title": "Vendor template name", 
      "type": "string"
    }
  }, 
  "title": "Policy Service Profile for a given Service", 
  "type": "object"
}

PolicySubAttributes (type)

{
  "additionalProperties": false, 
  "id": "PolicySubAttributes", 
  "module_id": "PolicyContextProfile", 
  "properties": {
    "datatype": {
      "enum": [
        "STRING"
      ], 
      "required": true, 
      "title": "Datatype for sub attribute", 
      "type": "string"
    }, 
    "key": {
      "enum": [
        "TLS_CIPHER_SUITE", 
        "TLS_VERSION", 
        "CIFS_SMB_VERSION"
      ], 
      "required": true, 
      "title": "Key for sub attribute", 
      "type": "string"
    }, 
    "value": {
      "description": "Multiple sub attribute values can be specified as elements of array.", 
      "items": {
        "type": "string"
      }, 
      "minItems": 1, 
      "required": true, 
      "title": "Value for sub attribute key", 
      "type": "array", 
      "uniqueItems": true
    }
  }, 
  "title": "Policy Sub Attributes data holder", 
  "type": "object"
}

PolicyTask (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "description": "This object holds the information of the task.", 
  "extends": {
    "$ref": "TaskProperties
  }, 
  "id": "PolicyTask", 
  "module_id": "PolicyTask", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "async_response_available": {
      "display": {
        "order": 13
      }, 
      "readonly": true, 
      "title": "True if response for asynchronous request is available", 
      "type": "boolean"
    }, 
    "cancelable": {
      "display": {
        "order": 8
      }, 
      "readonly": true, 
      "title": "True if this task can be canceled", 
      "type": "boolean"
    }, 
    "description": {
      "display": {
        "order": 2
      }, 
      "readonly": true, 
      "title": "Description of the task", 
      "type": "string"
    }, 
    "end_time": {
      "$ref": "EpochMsTimestamp, 
      "display": {
        "order": 6
      }, 
      "readonly": true, 
      "title": "The end time of the task in epoch milliseconds"
    }, 
    "failure_msg": {
      "description": "This property holds the reason of the task failure, if any.", 
      "readonly": true, 
      "title": "Reason of the task failure", 
      "type": "string"
    }, 
    "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 information", 
  "type": "object"
}

PolicyTepCsvListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "CsvListResult
  }, 
  "id": "PolicyTepCsvListResult", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "file_name": {
      "description": "File name set by HTTP server if API  returns CSV result as a file.", 
      "required": false, 
      "title": "File name", 
      "type": "string"
    }, 
    "last_update_timestamp": {
      "$ref": "EpochMsTimestamp, 
      "description": "Timestamp when the data was last updated; unset if data source has never updated the data.", 
      "readonly": true
    }, 
    "results": {
      "items": {
        "$ref": "PolicyTepTableCsvRecord
      }, 
      "required": false, 
      "type": "array"
    }
  }, 
  "type": "object"
}

PolicyTepListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "PolicyTepListResult", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "last_update_timestamp": {
      "$ref": "EpochMsTimestamp, 
      "description": "Timestamp when the data was last updated; unset if data source has never updated the data.", 
      "readonly": true
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "PolicyTepTableEntry
      }, 
      "required": false, 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "transport_node_id": {
      "readonly": true, 
      "required": false, 
      "title": "Transport node identifier", 
      "type": "string"
    }
  }, 
  "type": "object"
}

PolicyTepTableCsvRecord (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "CsvRecord
  }, 
  "id": "PolicyTepTableCsvRecord", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "segment_id": {
      "description": "This is the identifier of the TEP segment. This segment is NOT the same as logical segment or logical switch.", 
      "required": false, 
      "title": "TEP segment identifier", 
      "type": "string"
    }, 
    "tep_ip": {
      "$ref": "IPAddress, 
      "required": false, 
      "title": "The tunnel endpoint IP address"
    }, 
    "tep_label": {
      "required": true, 
      "title": "The tunnel endpoint label", 
      "type": "integer"
    }, 
    "tep_mac_address": {
      "required": true, 
      "title": "The tunnel endpoint MAC address", 
      "type": "string"
    }
  }, 
  "type": "object"
}

PolicyTepTableEntry (type)

{
  "additionalProperties": false, 
  "id": "PolicyTepTableEntry", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "segment_id": {
      "required": false, 
      "title": "The segment Id", 
      "type": "string"
    }, 
    "tep_ip": {
      "$ref": "IPAddress, 
      "required": false, 
      "title": "The tunnel endpoint IP address"
    }, 
    "tep_label": {
      "required": false, 
      "title": "The tunnel endpoint label", 
      "type": "integer"
    }, 
    "tep_mac_address": {
      "required": false, 
      "title": "The tunnel endpoint MAC address", 
      "type": "string"
    }
  }, 
  "type": "object"
}

PolicyTier1MulticastConfig (type)

{
  "additionalProperties": false, 
  "description": "Multicast routing configuration.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "PolicyTier1MulticastConfig", 
  "module_id": "PolicyMulticast", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "enabled": {
      "default": false, 
      "description": "Enable/disable Multicast Configuration. Whenever service router needs to be added/deleted from tier1, user needs to disable multicast first.", 
      "required": false, 
      "title": "Enable/disable Multicast Configuration", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Multicast routing configuration", 
  "type": "object"
}

PolicyTimeIntervalValue (type)

{
  "id": "PolicyTimeIntervalValue", 
  "module_id": "PolicyFirewallScheduler", 
  "properties": {
    "end_interval": {
      "description": "Time in 24 hour and minutes in multiple of 30. Example, 17:30.", 
      "required": true, 
      "title": "End time of the interval", 
      "type": "string"
    }, 
    "start_interval": {
      "description": "Time in 24 hour and minutes in multiple of 30. Example, 9:00.", 
      "required": true, 
      "title": "Start time of the interval", 
      "type": "string"
    }
  }, 
  "title": "Time interval on which firewall schedule will be applicable", 
  "type": "object"
}

PolicyTransportZone (type)

{
  "additionalProperties": false, 
  "description": "Transport Zone.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "PolicyTransportZone", 
  "module_id": "PolicyEnforcementPointManagement", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "is_default": {
      "default": false, 
      "description": "Flag to indicate if the transport zone is the default one. Only one transport zone can be the default one for a given transport zone type.", 
      "title": "Flag to indicate if the transport zone is the default one", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "nsx_id": {
      "description": "UUID of transport zone on NSX-T enforcement point.", 
      "readonly": true, 
      "title": "Transport Zone UUID on NSX-T Enforcement Point", 
      "type": "string"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "tz_type": {
      "description": "Transport Zone Type.", 
      "enum": [
        "OVERLAY_STANDARD", 
        "OVERLAY_ENS", 
        "VLAN_BACKED", 
        "UNKNOWN"
      ], 
      "readonly": true, 
      "title": "Transport Zone Type", 
      "type": "string"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }, 
    "uplink_teaming_policy_names": {
      "description": "The names of switching uplink teaming policies that all transport nodes in this transport zone support. Uplinkin teaming policies are only valid for VLAN backed transport zones.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Names of the switching uplink teaming policies that are supported by this transport zone.", 
      "type": "array"
    }
  }, 
  "search_dsl_exclude": true, 
  "title": "Transport Zone", 
  "type": "object"
}

PolicyTransportZoneListRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "Policy Transport Zone list request parameters.", 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "PolicyTransportZoneListRequestParameters", 
  "module_id": "PolicyEnforcementPointManagement", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Policy Transport Zone List Request Parameters", 
  "type": "object"
}

PolicyTransportZoneListResult (type)

{
  "additionalProperties": false, 
  "description": "Paged Collection of Transport Zone", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "PolicyTransportZoneListResult", 
  "module_id": "PolicyEnforcementPointManagement", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Transport Zone list result.", 
      "items": {
        "$ref": "PolicyTransportZone
      }, 
      "required": true, 
      "title": "Transport Zone List Result", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of Transport Zone", 
  "type": "object"
}

PolicyTunnelDigestAlgorithm (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "The TunnelDigestAlgorithms are used to verify message integrity during tunnel establishment. SHA1 produces 160 bits hash and SHA2_256 produces 256 bit hash.", 
  "enum": [
    "SHA1", 
    "SHA2_256"
  ], 
  "id": "PolicyTunnelDigestAlgorithm", 
  "module_id": "PolicyL3Vpn", 
  "title": "Digest Algorithms used in tunnel establishment", 
  "type": "string"
}

PolicyTunnelEncryptionAlgorithm (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "TunnelEncryption algorithms are used to ensure confidentiality of the messages exchanged during Tunnel negotiations. AES stands for Advanced Encryption Standards. AES_128 uses 128-bit keys whereas AES_256 uses 256-bit keys for encryption and decryption. AES_GCM stands for Advanced Encryption Standard(AES) in Galois/Counter Mode (GCM) and is used to provide both confidentiality and data origin authentication.", 
  "enum": [
    "AES_128", 
    "AES_256", 
    "AES_GCM_128", 
    "AES_GCM_192", 
    "AES_GCM_256"
  ], 
  "id": "PolicyTunnelEncryptionAlgorithm", 
  "module_id": "PolicyL3Vpn", 
  "title": "Encryption algorithm used in tunnel", 
  "type": "string"
}

PolicyUrlCategorizationConfig (type)

{
  "additionalProperties": false, 
  "description": "The type contains information about the configuration of the feature for a specific node. It contains information like the whether the feature is enabled/disabled, the context profiles defining the category list to detect.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "PolicyUrlCategorizationConfig", 
  "module_id": "PolicyUrlCategorization", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "context_profiles": {
      "deprecated": true, 
      "description": "The ids of the context profiles that provides the list of categories to be detected. This field is deprecated. URL Categorization will not be supported in association with context profiles.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Context profiles", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "enabled": {
      "description": "Property which specifies the enabling/disabling of the feature.", 
      "required": true, 
      "title": "Enabled", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }, 
    "update_frequency": {
      "default": 30, 
      "description": "The frequency in minutes at which the updates are downloaded from the URL categorization cloud service. The minimum allowed value is 5 minutes.", 
      "minimum": 5, 
      "required": false, 
      "title": "Policy URL Categorization Update Frequency", 
      "type": "int"
    }
  }, 
  "title": "URL categorization entity", 
  "type": "object"
}

PoolMemberAdminStateType (type)

{
  "additionalProperties": false, 
  "description": "User can set the admin state of a member to ENABLED or DISABLED or GRACEFUL_DISABLED. By default, when a member is added, it is ENABLED. If a member is set to DISABLED, it is not selected for any new connections. Active connections, however, will continue to be processed by it. New connections with matching persistence entries pointing to DISABLED members are not sent to those DISABLED members. Those connections are assigned to other members of the pool and the corresponding persistence entries are updated to point to the newly selected server. To allow for a more graceful way of taking down servers for maintenance, a routine task, another admin state GRACEFUL_DISABLED is supported. Existing connections to a member in GRACEFUL_DISABLED state continue to be processed.", 
  "enum": [
    "ENABLED", 
    "DISABLED", 
    "GRACEFUL_DISABLED"
  ], 
  "id": "PoolMemberAdminStateType", 
  "module_id": "LoadBalancer", 
  "title": "pool member admin state", 
  "type": "string"
}

PoolMemberSetting (type)

{
  "additionalProperties": false, 
  "description": "The setting is used to add, update or remove pool members from pool. For static pool members, admin_state, display_name and weight can be updated. For dynamic pool members, only admin_state can be updated.", 
  "id": "PoolMemberSetting", 
  "module_id": "LoadBalancer", 
  "properties": {
    "admin_state": {
      "$ref": "PoolMemberAdminStateType, 
      "default": "ENABLED", 
      "required": false, 
      "title": "Member admin state"
    }, 
    "display_name": {
      "description": "Only applicable to static pool members. If supplied for a pool defined by a grouping object, update API would fail.", 
      "required": false, 
      "title": "Pool member display name", 
      "type": "string"
    }, 
    "ip_address": {
      "$ref": "IPAddress, 
      "required": true, 
      "title": "Pool member IP address"
    }, 
    "port": {
      "$ref": "PortElement, 
      "required": false, 
      "title": "Pool member port number"
    }, 
    "weight": {
      "description": "Only applicable to static pool members. If supplied for a pool defined by a grouping object, update API would fail.", 
      "maximum": 255, 
      "minimum": 1, 
      "required": false, 
      "title": "Pool member weight", 
      "type": "integer"
    }
  }, 
  "title": "Pool member setting", 
  "type": "object"
}

PortAddressBindingEntry (type)

{
  "additionalProperties": false, 
  "description": "Detailed information about static address for the port.", 
  "id": "PortAddressBindingEntry", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "ip_address": {
      "description": "IP Address for port binding", 
      "required": false, 
      "title": "IP address", 
      "type": "string"
    }, 
    "mac_address": {
      "$ref": "MACAddress, 
      "description": "Mac address for port binding", 
      "required": false, 
      "title": "MAC address"
    }, 
    "vlan_id": {
      "$ref": "VlanID, 
      "description": "VLAN ID for port binding", 
      "required": false, 
      "title": "VLAN ID"
    }
  }, 
  "title": "Address binding information", 
  "type": "object"
}

PortAttacher (type)

{
  "id": "PortAttacher", 
  "module_id": "LogicalPort", 
  "properties": {
    "entity": {
      "description": "This is a vmknic name if the attacher is vmknic. Otherwise, it is full path of the attached VM's config file", 
      "readonly": false, 
      "required": true, 
      "title": "Reference to the attached entity", 
      "type": "string"
    }, 
    "host": {
      "readonly": false, 
      "required": true, 
      "title": "TransportNode on which the attacher resides", 
      "type": "string"
    }
  }, 
  "title": "VM or vmknic entity attached to LogicalPort", 
  "type": "object"
}

PortAttachment (type)

{
  "additionalProperties": false, 
  "description": "Detail information about port attachment", 
  "id": "PortAttachment", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "allocate_addresses": {
      "description": "Indicate how IP will be allocated for the port", 
      "enum": [
        "IP_POOL", 
        "MAC_POOL", 
        "BOTH", 
        "NONE", 
        "DHCP"
      ], 
      "required": false, 
      "title": "Allocate addresses", 
      "type": "string"
    }, 
    "app_id": {
      "description": "ID used to identify/look up a child attachment behind a parent attachment", 
      "required": false, 
      "title": "App Id", 
      "type": "string"
    }, 
    "bms_interface_config": {
      "$ref": "AttachedInterfaceEntry, 
      "description": "Indicate application interface configuration for Bare Metal Server.", 
      "required": false, 
      "title": "Application interface configuration for Bare metal server"
    }, 
    "context_id": {
      "description": "If type is CHILD and the parent port is on the same segment as the child port, then this field should be VIF ID of the parent port. If type is CHILD and the parent port is on a different segment, then this field should be policy path of the parent port. If type is INDEPENDENT/STATIC, then this field should be transport node ID.", 
      "required": false, 
      "title": "Context ID based on the type", 
      "type": "string"
    }, 
    "context_type": {
      "description": "Set to PARENT when type field is CHILD. Read only field.", 
      "enum": [
        "PARENT"
      ], 
      "readonly": true, 
      "title": "Context Type", 
      "type": "string"
    }, 
    "evpn_vlans": {
      "description": "List of Evpn tenant VLAN IDs the Parent logical-port serves in Evpn Route-Server mode. Only effective when attachment type is PARENT and the logical-port is attached to vRouter VM.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 1000, 
      "minItems": 0, 
      "required": false, 
      "title": "Evpn tenant VLAN IDs the Parent logical-port serves.", 
      "type": "array"
    }, 
    "hyperbus_mode": {
      "default": "DISABLE", 
      "description": "Flag to indicate if hyperbus configuration is required.", 
      "enum": [
        "ENABLE", 
        "DISABLE"
      ], 
      "title": "Hyperbus mode", 
      "type": "string"
    }, 
    "id": {
      "description": "VIF UUID on NSX Manager. If the attachement type is PARENT, this property is required.", 
      "required": false, 
      "title": "Port attachment ID", 
      "type": "string"
    }, 
    "traffic_tag": {
      "$ref": "VlanID, 
      "description": "Not valid when type field is INDEPENDENT, mainly used to identify traffic from different ports in container use case.", 
      "required": false, 
      "title": "VLAN ID"
    }, 
    "type": {
      "description": "Type of port attachment. STATIC is added to replace INDEPENDENT. INDEPENDENT type and PARENT type are deprecated.", 
      "enum": [
        "PARENT", 
        "CHILD", 
        "INDEPENDENT", 
        "STATIC"
      ], 
      "required": false, 
      "title": "Attachement type", 
      "type": "string"
    }
  }, 
  "title": "Attachment information on the port", 
  "type": "object"
}

PortDiscoveryProfileBindingMap (type)

{
  "additionalProperties": false, 
  "description": "This entity will be used to establish association between discovery profile and Port. Using this entity, user can specify intent for applying discovery profile to particular Port. Port here is Logical Port.", 
  "extends": {
    "$ref": "DiscoveryProfileBindingMap
  }, 
  "id": "PortDiscoveryProfileBindingMap", 
  "module_id": "PolicyDiscoveryProfileBinding", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ip_discovery_profile_path": {
      "description": "PolicyPath of associated IP Discovery Profile", 
      "required": false, 
      "title": "IP Discovery Profile Path", 
      "type": "string"
    }, 
    "mac_discovery_profile_path": {
      "description": "PolicyPath of associated Mac Discovery Profile", 
      "required": false, 
      "title": "Mac Discovery Profile Path", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Port Discovery Profile binding map", 
  "type": "object"
}

PortDiscoveryProfileBindingMapListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "PortDiscoveryProfileBindingMapListRequestParameters", 
  "module_id": "PolicyDiscoveryProfileBinding", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Port Discovery Profile Binding Map list request parameters", 
  "type": "object"
}

PortDiscoveryProfileBindingMapListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "PortDiscoveryProfileBindingMapListResult", 
  "module_id": "PolicyDiscoveryProfileBinding", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "PortDiscoveryProfileBindingMap
      }, 
      "required": true, 
      "title": "Port Discovery Profile Binding Map list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged collection of Port Discovery Profile Binding Maps", 
  "type": "object"
}

PortElement (type)

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

PortMirroringProfile (type)

{
  "additionalProperties": false, 
  "description": "Mirrors Data from source to destination", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "PortMirroringProfile", 
  "module_id": "PolicyPortMirroring", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "destination_group": {
      "description": "Data from source group will be copied to members of destination group. Only IPSET group and group with membership criteria VM is supported. IPSET group allows only three ip's.", 
      "required": true, 
      "title": "Destination group path", 
      "type": "string"
    }, 
    "direction": {
      "default": "BIDIRECTIONAL", 
      "description": "Port mirroring profile direction", 
      "enum": [
        "INGRESS", 
        "EGRESS", 
        "BIDIRECTIONAL"
      ], 
      "title": "Direction", 
      "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"
    }, 
    "encapsulation_type": {
      "default": "GRE", 
      "description": "User can provide Mirror Destination type e.g GRE, ERSPAN_TWO or ERSPAN_THREE.If profile type is REMOTE_L3_SPAN, encapsulation type is used else ignored.", 
      "enum": [
        "GRE", 
        "ERSPAN_TWO", 
        "ERSPAN_THREE"
      ], 
      "required": false, 
      "title": "Mirror Destination encapsulation type", 
      "type": "string"
    }, 
    "erspan_id": {
      "default": 0, 
      "description": "Used by physical switch for the mirror traffic forwarding. Must be provided and only effective when encapsulation type is ERSPAN type II or type III.", 
      "maximum": 1023, 
      "minimum": 0, 
      "required": false, 
      "title": "ERSPAN session id", 
      "type": "int"
    }, 
    "gre_key": {
      "default": 0, 
      "description": "User-configurable 32-bit key only for GRE", 
      "minimum": 0, 
      "required": false, 
      "title": "GRE encapsulation key", 
      "type": "int"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "profile_type": {
      "default": "REMOTE_L3_SPAN", 
      "description": "Allows user to select type of port mirroring session.", 
      "enum": [
        "REMOTE_L3_SPAN", 
        "LOGICAL_SPAN"
      ], 
      "required": false, 
      "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"
    }, 
    "snap_length": {
      "description": "If this property is set, the packet will be truncated to the provided length. If this property is unset, entire packet will be mirrored.", 
      "maximum": 65535, 
      "minimum": 60, 
      "required": false, 
      "title": "Maximum packet length for packet truncation", 
      "type": "int"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "tcp_ip_stack": {
      "default": "Default", 
      "description": "User can provide Mirror stack or Default stack to send mirror traffic. If profile type is REMOTE_L3_SPAN, tcp_ip_stack type is used else ignored.", 
      "enum": [
        "Default", 
        "Mirror"
      ], 
      "required": false, 
      "title": "Mirror Destination encapsulation type", 
      "type": "string"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Mirrors Data from source to destination", 
  "type": "object"
}

PortMirroringProfileListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "PortMirroringProfileListRequestParameters", 
  "module_id": "PolicyPortMirroring", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Port mirroring profile request parameters", 
  "type": "object"
}

PortMirroringProfileListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "PortMirroringProfileListResult", 
  "module_id": "PolicyPortMirroring", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "PortMirroringProfile
      }, 
      "required": true, 
      "title": "Port Mirroring Profiles list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged collection of port mirroring profiles", 
  "type": "object"
}

PortMonitoringProfileBindingMap (type)

{
  "additionalProperties": false, 
  "description": "This entity will be used to establish association between monitoring profile and Port. Using this entity, user can specify intent for applying monitoring profile to particular Port. Port here is Segment Port.", 
  "extends": {
    "$ref": "MonitoringProfileBindingMap
  }, 
  "id": "PortMonitoringProfileBindingMap", 
  "module_id": "PolicyMonitoringProfileBinding", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ipfix_l2_profile_path": {
      "description": "PolicyPath of associated IPFIX L2 Profile", 
      "required": false, 
      "title": "IPFIX L2 Profile Path", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "port_mirroring_profile_path": {
      "description": "PolicyPath of associated Port Mirroring Profile", 
      "required": false, 
      "title": "Port Mirroring Profile Path", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Port Monitoring Profile binding map", 
  "type": "object"
}

PortMonitoringProfileBindingMapListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "PortMonitoringProfileBindingMapListRequestParameters", 
  "module_id": "PolicyMonitoringProfileBinding", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Port Monitoring Profile Binding Map list request parameters", 
  "type": "object"
}

PortMonitoringProfileBindingMapListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "PortMonitoringProfileBindingMapListResult", 
  "module_id": "PolicyMonitoringProfileBinding", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "PortMonitoringProfileBindingMap
      }, 
      "required": true, 
      "title": "Port Monitoring Profile Binding Map list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged collection of Port Monitoring Profile Binding Maps", 
  "type": "object"
}

PortQoSProfileBindingMap (type)

{
  "additionalProperties": false, 
  "description": "This entity will be used to establish association between qos profile and Port. Using this entity, you can  specify intent for applying qos profile to particular Port. Port here is Segment Port.", 
  "extends": {
    "$ref": "QoSProfileBindingMap
  }, 
  "id": "PortQoSProfileBindingMap", 
  "module_id": "PolicyQoSProfileBinding", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "qos_profile_path": {
      "description": "PolicyPath of associated  QoS Profile", 
      "required": false, 
      "title": "QoS Profile Path", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "search_dsl_name": [
    "port qos profile binding map"
  ], 
  "title": "Port QoS Profile binding map", 
  "type": "object"
}

PortQoSProfileBindingMapListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "PortQoSProfileBindingMapListRequestParameters", 
  "module_id": "PolicyQoSProfileBinding", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Port QoS Profile Binding Map list request parameters", 
  "type": "object"
}

PortQoSProfileBindingMapListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "PortQoSProfileBindingMapListResult", 
  "module_id": "PolicyQoSProfileBinding", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "PortQoSProfileBindingMap
      }, 
      "required": true, 
      "title": "Port QoS Profile Binding Map list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged collection of Port QoS Profile Binding Maps", 
  "type": "object"
}

PortSecurityProfileBindingMap (type)

{
  "additionalProperties": false, 
  "description": "Contains the binding relationship between port and security profile.", 
  "extends": {
    "$ref": "SecurityProfileBindingMap
  }, 
  "id": "PortSecurityProfileBindingMap", 
  "module_id": "PolicySecurityProfileBinding", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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"
    }, 
    "segment_security_profile_path": {
      "description": "The policy path of the asscociated Segment Security profile", 
      "required": false, 
      "title": "Segment Security Profile Path", 
      "type": "string"
    }, 
    "spoofguard_profile_path": {
      "description": "The policy path of the asscociated SpoofGuard profile", 
      "required": false, 
      "title": "SpoofGuard Profile Path", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Security profile binding map for port", 
  "type": "object"
}

PortSecurityProfileBindingMapListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "PortSecurityProfileBindingMapListRequestParameters", 
  "module_id": "PolicySecurityProfileBinding", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Port security profile binding map request parameters", 
  "type": "object"
}

PortSecurityProfileBindingMapListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "PortSecurityProfileBindingMapListResult", 
  "module_id": "PolicySecurityProfileBinding", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "PortSecurityProfileBindingMap
      }, 
      "required": true, 
      "title": "Port security profile binding map list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged collection of port security profile binding maps", 
  "type": "object"
}

PortStatus (type)

{
  "additionalProperties": false, 
  "id": "PortStatus", 
  "properties": {
    "enabled": {
      "required": true, 
      "title": "indicates if the RabbitMQ management port is set or not", 
      "type": "boolean"
    }
  }, 
  "title": "indicates if the RabbitMQ management port is set or not", 
  "type": "object"
}

PrefixEntry (type)

{
  "additionalProperties": false, 
  "id": "PrefixEntry", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "action": {
      "default": "PERMIT", 
      "description": "Action for the prefix list.", 
      "enum": [
        "PERMIT", 
        "DENY"
      ], 
      "required": false, 
      "title": "Action for the prefix list", 
      "type": "string"
    }, 
    "ge": {
      "description": "Prefix length greater than or equal to.", 
      "maximum": 128, 
      "minimum": 1, 
      "title": "Prefix length greater than or equal to", 
      "type": "int"
    }, 
    "le": {
      "description": "Prefix length less than or equal to.", 
      "maximum": 128, 
      "minimum": 1, 
      "title": "Prefix length less than or equal to", 
      "type": "int"
    }, 
    "network": {
      "description": "Network prefix in CIDR format. \"ANY\" matches all networks.", 
      "required": true, 
      "title": "Network prefix in CIDR format", 
      "type": "string"
    }
  }, 
  "title": "Network prefix entry", 
  "type": "object"
}

PrefixList (type)

{
  "additionalProperties": false, 
  "description": "A named list of prefixes for routing purposes.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "PrefixList", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "prefixes": {
      "description": "Specify ordered list of network prefixes.", 
      "items": {
        "$ref": "PrefixEntry
      }, 
      "minItems": 1, 
      "required": true, 
      "title": "Ordered list of network prefixes", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "A named list of prefixes for routing purposes", 
  "type": "object"
}

PrefixListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "PrefixListRequestParameters", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "PrefixList request parameters", 
  "type": "object"
}

PrefixListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "PrefixListResult", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "PrefixList
      }, 
      "required": true, 
      "title": "PrefixList results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged collection of PrefixLists", 
  "type": "object"
}

ProfileBindingListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "ProfileBindingListRequestParameters", 
  "module_id": "PolicyProfile", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Profile binding map list request parameters", 
  "type": "object"
}

ProfileBindingMap (type)

{
  "additionalProperties": false, 
  "description": "This entity will be used to establish association between profile and policy entities.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "ProfileBindingMap", 
  "module_id": "PolicyProfile", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "profile_path": {
      "description": "PolicyPath of associated Profile", 
      "required": true, 
      "title": "Profile Path", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Policy base profile binding map", 
  "type": "object"
}

ProfileSeverity (type)

{
  "enum": [
    "CRITICAL", 
    "HIGH", 
    "MEDIUM", 
    "LOW"
  ], 
  "id": "ProfileSeverity", 
  "module_id": "PolicyIDS", 
  "title": "Intrusion Detection System Profile severity", 
  "type": "string"
}

ProfileSupportedAttributesListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "ProfileSupportedAttributesListRequestParameters", 
  "module_id": "PolicyContextProfile", 
  "properties": {
    "attribute_key": {
      "description": "It fetches attributes and subattributes for the given attribute key supported in the system which can be used for Policy Context Profile creation.", 
      "required": false, 
      "title": "Fetch attributes and sub-attributes for the given attribute key", 
      "type": "string"
    }, 
    "attribute_source": {
      "default": "SYSTEM", 
      "description": "It fetches attributes and sub attributes for the given attribute key based on the source of attribute which can be used for Policy Context Profile creation.", 
      "enum": [
        "ALL", 
        "CUSTOM", 
        "SYSTEM"
      ], 
      "required": false, 
      "title": "Source of the attribute, System Defined or custom", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Profile Attributes list request parameters.", 
  "type": "object"
}

PropertyItem (type)

{
  "additionalProperties": false, 
  "description": "Represents a label-value pair.", 
  "id": "PropertyItem", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "properties": {
    "condition": {
      "description": "If the condition is met then the property will be displayed. Examples of expression syntax are provided under 'example_request' section of 'CreateWidgetConfiguration' API.", 
      "maxLength": 1024, 
      "title": "Expression for evaluating condition", 
      "type": "string"
    }, 
    "field": {
      "description": "Represents field value of the property.", 
      "maxLength": 1024, 
      "required": true, 
      "title": "Field of the Property", 
      "type": "string"
    }, 
    "heading": {
      "default": false, 
      "description": "Set to true if the field is a heading. Default is false.", 
      "title": "If true, represents the field as a heading", 
      "type": "boolean"
    }, 
    "label": {
      "$ref": "Label, 
      "description": "If a field represents a heading, then label is not needed", 
      "title": "Label of the property"
    }, 
    "navigation": {
      "description": "Hyperlink of the specified UI page that provides details. This will be linked with value of the property.", 
      "maxLength": 1024, 
      "title": "Navigation to a specified UI page", 
      "type": "string"
    }, 
    "render_configuration": {
      "description": "Render configuration to be applied, if any.", 
      "items": {
        "$ref": "RenderConfiguration
      }, 
      "title": "Render Configuration", 
      "type": "array"
    }, 
    "separator": {
      "default": false, 
      "description": "If true, separates this property in a widget.", 
      "title": "A separator after this property", 
      "type": "boolean"
    }, 
    "type": {
      "default": "String", 
      "description": "Data type of the field.", 
      "enum": [
        "String", 
        "Number", 
        "Date", 
        "Url"
      ], 
      "maxLength": 255, 
      "required": true, 
      "title": "field data type", 
      "type": "string"
    }
  }, 
  "title": "LabelValue Property", 
  "type": "object"
}

Protocol (type)

{
  "abstract": true, 
  "additionalProperties": {}, 
  "id": "Protocol", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "name"
  }, 
  "properties": {
    "name": {
      "enum": [
        "http", 
        "https", 
        "scp", 
        "sftp"
      ], 
      "required": true, 
      "title": "Protocol name", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ProtocolVersion (type)

{
  "additionalProperties": false, 
  "id": "ProtocolVersion", 
  "properties": {
    "enabled": {
      "required": true, 
      "title": "Enable status for this protocol version", 
      "type": "boolean"
    }, 
    "name": {
      "required": true, 
      "title": "Name of the TLS protocol version", 
      "type": "string"
    }
  }, 
  "title": "TLS protocol version", 
  "type": "object"
}

QoSBaseRateLimiter (type)

{
  "abstract": true, 
  "id": "QoSBaseRateLimiter", 
  "module_id": "PolicyQoS", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "resource_type"
  }, 
  "properties": {
    "enabled": {
      "required": true, 
      "type": "boolean"
    }, 
    "resource_type": {
      "default": "IngressRateLimiter", 
      "description": "Type rate limiter", 
      "enum": [
        "IngressRateLimiter", 
        "IngressBroadcastRateLimiter", 
        "EgressRateLimiter"
      ], 
      "required": true, 
      "type": "string"
    }
  }, 
  "title": "A Limiter configuration entry that specifies type and metrics", 
  "type": "object"
}

QoSDscp (type)

{
  "description": "Dscp value is ignored in case of 'TRUSTED' DscpTrustMode.", 
  "id": "QoSDscp", 
  "module_id": "PolicyQoS", 
  "properties": {
    "mode": {
      "$ref": "DscpTrustMode
    }, 
    "priority": {
      "default": 0, 
      "maximum": 63, 
      "minimum": 0, 
      "title": "Internal Forwarding Priority", 
      "type": "int"
    }
  }, 
  "required": true, 
  "title": "One of QoS or Encapsulated-Remote-Switched-Port-Analyzer", 
  "type": "object"
}

QoSProfile (type)

{
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "QoSProfile", 
  "module_id": "PolicyQoS", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "class_of_service": {
      "default": 0, 
      "description": "Class of service groups similar types of traffic in the network and each type of traffic is treated as a class with its own level of service priority. The lower priority traffic is slowed down or in some cases dropped to provide better throughput for higher priority traffic.", 
      "maximum": 7, 
      "minimum": 0, 
      "title": "Class of service", 
      "type": "int"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "dscp": {
      "$ref": "QoSDscp
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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"
    }, 
    "shaper_configurations": {
      "description": "Array of Rate limiter configurations to applied on Segment or Port.", 
      "items": {
        "$ref": "QoSBaseRateLimiter
      }, 
      "maxItems": 3, 
      "minItems": 0, 
      "required": false, 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "search_dsl_name": [
    "qos segment profile"
  ], 
  "type": "object"
}

QoSProfileBindingMap (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "QoSProfileBindingMap", 
  "module_id": "PolicyQoSProfileBinding", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Base QoS Profile Binding Map", 
  "type": "object"
}

QoSProfileListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "QoSProfileListRequestParameters", 
  "module_id": "PolicyQoS", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "QoS Profile request parameters", 
  "type": "object"
}

QoSProfileListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "QoSProfileListResult", 
  "module_id": "PolicyQoS", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "QoSProfile
      }, 
      "required": true, 
      "title": "QoS profiles list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged collection of QoS profiles", 
  "type": "object"
}

RAConfig (type)

{
  "additionalProperties": false, 
  "id": "RAConfig", 
  "module_id": "Routing", 
  "properties": {
    "hop_limit": {
      "default": 64, 
      "description": "The maximum number of hops through which packets can pass before being discarded.", 
      "maximum": 255, 
      "minimum": 0, 
      "required": false, 
      "title": "Hop limit", 
      "type": "integer"
    }, 
    "prefix_lifetime": {
      "default": 2592000, 
      "description": "The time interval in seconds, in which the prefix is advertised as valid.", 
      "maximum": 4294967295, 
      "minimum": 0, 
      "required": false, 
      "title": "Lifetime of prefix", 
      "type": "integer"
    }, 
    "prefix_preferred_time": {
      "default": 604800, 
      "description": "The time interval in seconds, in which the prefix is advertised as preferred.", 
      "maximum": 4294967295, 
      "minimum": 0, 
      "required": false, 
      "title": "Prefix preferred time", 
      "type": "integer"
    }, 
    "ra_interval": {
      "default": 600, 
      "description": "Interval between 2 Router advertisement in seconds.", 
      "maximum": 1800, 
      "minimum": 4, 
      "required": false, 
      "title": "RA interval", 
      "type": "integer"
    }, 
    "router_lifetime": {
      "default": 1800, 
      "description": "Router lifetime value in seconds. A value of 0 indicates the router is not a default router for the receiving end. Any other value in this field specifies the lifetime, in seconds, associated with this router as a default router.", 
      "maximum": 65520, 
      "minimum": 0, 
      "required": false, 
      "title": "Lifetime of router", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

RAMode (type)

{
  "additionalProperties": false, 
  "description": "Router Advertisement Modes. DISABLED - RA is disabled SLAAC_DNS_THROUGH_RA - Stateless address auto-configuration RA for address and configuration SLAAC_DNS_THROUGH_DHCP - SLAAC RA for address and DHCPv6 for configuration DHCP_ADDRESS_AND_DNS_THROUGH_DHCP - DHCPv6 for address and configurations SLAAC_AND_ADDRESS_DNS_THROUGH_DHCP - SLAAC RA and DHCPv6 for address and configurations", 
  "enum": [
    "DISABLED", 
    "SLAAC_DNS_THROUGH_RA", 
    "SLAAC_DNS_THROUGH_DHCP", 
    "DHCP_ADDRESS_AND_DNS_THROUGH_DHCP", 
    "SLAAC_AND_ADDRESS_DNS_THROUGH_DHCP"
  ], 
  "id": "RAMode", 
  "module_id": "Routing", 
  "title": "Router Advertisement Mode", 
  "type": "string"
}

RaDNSConfig (type)

{
  "additionalProperties": false, 
  "id": "RaDNSConfig", 
  "module_id": "Routing", 
  "properties": {
    "dns_server": {
      "description": "DNS server.", 
      "items": {
        "$ref": "IPv6Address
      }, 
      "maxItems": 8, 
      "required": false, 
      "title": "DNS server", 
      "type": "array"
    }, 
    "dns_server_lifetime": {
      "default": 1800000, 
      "maximum": 4294967295, 
      "minimum": 0, 
      "required": false, 
      "title": "Lifetime of DNS server in milliseconds", 
      "type": "integer"
    }, 
    "domain_name": {
      "description": "Domain name in RA message.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 8, 
      "required": false, 
      "title": "Domain name", 
      "type": "array"
    }, 
    "domain_name_lifetime": {
      "default": 1800000, 
      "maximum": 4294967295, 
      "minimum": 0, 
      "required": false, 
      "title": "Lifetime of Domain names in milliseconds", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

Reaction (type)

{
  "additionalProperties": false, 
  "description": "Reaction represents a programmable entity which encapsulates the events and the actions in response to the events, or simply \"If This Then That\".", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "Reaction", 
  "module_id": "PolicyReaction", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "actions": {
      "description": "Actions that need to be taken when the events occur. These actions must appear in the order that they need to be taken in. This field can be interpreted as the HOW of the Reaction, or simply as \"Then That\".", 
      "items": {
        "$ref": "Action
      }, 
      "maxItems": 1, 
      "minItems": 1, 
      "required": true, 
      "title": "Reaction Actions", 
      "type": "array"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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"
    }, 
    "events": {
      "description": "Events that provide contextual variables about what the reaction should react to. This field can be interpreted as the WHAT of the Reaction, or simply as \"If This\" Clause.", 
      "items": {
        "$ref": "Event
      }, 
      "maxItems": 1, 
      "minItems": 1, 
      "required": true, 
      "title": "Reaction Events", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Reaction", 
  "type": "object"
}

RealizationListRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "List request params for the pass through type api that get data from the Enforcement point. The basic requirement for these kind of APIs is filtering by Enforcement point.", 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "RealizationListRequestParameters", 
  "module_id": "PolicyGroupRealization", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "enforcement_point_path": {
      "description": "The path of the enforcement point from which the list of members needs to be fetched. Forward slashes must be escaped using %2F.", 
      "required": false, 
      "title": "String Path of the enforcement point", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Realization list request params", 
  "type": "object"
}

RealizedStateRequestParameter (type)

{
  "description": "Request parameter that represents a binding between an intent path and enforcement point path. A request on the realized state can be parameterized with this pair and will be evaluted as follows: - {intent_path}: the request is evaluated on all enforcement points for the given intent. - {intent_path, enforcement_point_path}: the request is evaluated only on the given enforcement point for the given intent.", 
  "id": "RealizedStateRequestParameter", 
  "module_id": "PolicyRealizedState", 
  "properties": {
    "enforcement_point_path": {
      "description": "enforcement point path, forward slashes must be escaped using %2F", 
      "required": false, 
      "title": "String Path of the enforcement point", 
      "type": "string"
    }, 
    "intent_path": {
      "description": "Intent path of object, forward slashes must be escaped using %2F", 
      "required": true, 
      "title": "String Path of the intent object", 
      "type": "string"
    }
  }, 
  "title": "Binding between Intent and Enforcement Point Paths", 
  "type": "object"
}

RealizedVirtualMachine (type)

{
  "additionalProperties": false, 
  "experimental": true, 
  "extends": {
    "$ref": "PolicyRealizedResource
  }, 
  "id": "RealizedVirtualMachine", 
  "module_id": "PolicyRealizedState", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "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, 
      "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"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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_api": {
      "required": false, 
      "title": "Realization API of this object on enforcement point", 
      "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"
    }, 
    "runtime_error": {
      "description": "It define the root cause for runtime error.", 
      "required": false, 
      "title": "String representation of runtime error", 
      "type": "string"
    }, 
    "runtime_status": {
      "description": "Possible values could be UP, DOWN, UNKNOWN, DEGRADED This list is not exhaustive.", 
      "required": false, 
      "title": "String representation of runtime status", 
      "type": "string"
    }, 
    "state": {
      "enum": [
        "UNAVAILABLE", 
        "UNREALIZED", 
        "REALIZED", 
        "ERROR"
      ], 
      "required": true, 
      "title": "Realization state of this object", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Realized Virtual Machine", 
  "type": "object"
}

RealizedVirtualMachineListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "RealizedVirtualMachineListResult", 
  "module_id": "PolicyGroupStatistics", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "RealizedVirtualMachine, 
        "title": "Virtual machine list result"
      }, 
      "required": false, 
      "title": "Paged Collection of VMs", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

RecommendedFeaturePermission (type)

{
  "id": "RecommendedFeaturePermission", 
  "module_id": "AAA", 
  "properties": {
    "recommended_permissions": {
      "items": {
        "type": "string"
      }, 
      "required": true, 
      "title": "Permission", 
      "type": "array"
    }, 
    "src_features": {
      "items": {
        "type": "string"
      }, 
      "required": true, 
      "title": "List of source features", 
      "type": "array"
    }, 
    "target_feature": {
      "required": true, 
      "title": "Feature", 
      "type": "string"
    }
  }, 
  "title": "Recommended Feature Permission", 
  "type": "object"
}

RecommendedFeaturePermissionListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "RecommendedFeaturePermissionListResult", 
  "module_id": "AAA", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "RecommendedFeaturePermission
      }, 
      "required": true, 
      "title": "List results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

RedirectionPolicy (type)

{
  "additionalProperties": false, 
  "description": "Ordered list of rules long with the path of PolicyServiceInstance to which the traffic needs to be redirected. | Please note that the scope property must be provided for NS redirection | policy if redirect to is a service chain. For NS, when redirect to is not | to the service chain, and scope is specified on RedirectionPolicy, it | will be ignored. The scope will be determined from redirect to path | instead. For EW policy, scope must not be  supplied in the request. | Path to either Tier0 or Tier1 is allowed as the scope. Only 1 path | can be specified as a scope. | Also, note that, if stateful flag is not sent, it will be treated as true. If statelessness is intended, false must be sent explicitly as the value | for stateful field.", 
  "extends": {
    "$ref": "Policy
  }, 
  "id": "RedirectionPolicy", 
  "module_id": "PolicyServiceInsertion", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "category": {
      "description": "- Distributed Firewall - Policy framework provides five pre-defined categories for classifying a security policy. They are \"Ethernet\",\"Emergency\", \"Infrastructure\" \"Environment\" and \"Application\". There is a pre-determined order in which the policy framework manages the priority of these security policies. Ethernet category is for supporting layer 2 firewall rules. The other four categories are applicable for layer 3 rules. Amongst them, the Emergency category has the highest priority followed by Infrastructure, Environment and then Application rules. Administrator can choose to categorize a security policy into the above categories or can choose to leave it empty. If empty it will have the least precedence w.r.t the above four categories. - Edge Firewall - Policy Framework for Edge Firewall provides six pre-defined categories \"Emergency\", \"SystemRules\", \"SharedPreRules\", \"LocalGatewayRules\", \"AutoServiceRules\" and \"Default\", in order of priority of rules. All categories are allowed for Gatetway Policies that belong to 'default' Domain. However, for user created domains, category is restricted to \"SharedPreRules\" or \"LocalGatewayRules\" only. Also, the users can add/modify/delete rules from only the \"SharedPreRules\" and \"LocalGatewayRules\" categories. If user doesn't specify the category then defaulted to \"Rules\". System generated category is used by NSX created rules, for example BFD rules. Autoplumbed category used by NSX verticals to autoplumb data path rules. Finally, \"Default\" category is the placeholder default rules with lowest in the order of priority.", 
      "required": false, 
      "title": "A way to classify a security policy, if needed.", 
      "type": "string"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "comments": {
      "description": "Comments for security policy lock/unlock.", 
      "readonly": false, 
      "required": false, 
      "title": "SecurityPolicy lock/unlock comments", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "internal_sequence_number": {
      "description": "This field is to indicate the internal sequence number of a policy with respect to the policies across categories.", 
      "readonly": true, 
      "title": "Internal sequence number", 
      "type": "int"
    }, 
    "is_default": {
      "description": "A flag to indicate whether policy is a default policy.", 
      "readonly": true, 
      "required": false, 
      "title": "Default policy flag", 
      "type": "boolean"
    }, 
    "lock_modified_by": {
      "description": "ID of the user who last modified the lock for the secruity policy.", 
      "readonly": true, 
      "required": false, 
      "title": "User who locked the security policy", 
      "type": "string"
    }, 
    "lock_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "description": "SecurityPolicy locked/unlocked time in epoch milliseconds.", 
      "readonly": true, 
      "required": false, 
      "title": "SecuirtyPolicy locked/unlocked time"
    }, 
    "locked": {
      "default": false, 
      "description": "Indicates whether a security policy should be locked. If the security policy is locked by a user, then no other user would be able to modify this security policy. Once the user releases the lock, other users can update this security policy.", 
      "required": false, 
      "title": "Lock a security policy", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "north_south": {
      "description": "This is the read only flag which will state the direction of this | redirection policy. True denotes that it is NORTH-SOUTH and false | value means it is an EAST-WEST redirection policy.", 
      "readonly": true, 
      "title": "Flag to denote whether it is north south policy", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "redirect_to": {
      "description": "Paths to which traffic will be redirected to. As of now, only 1 is | supported. Paths allowed are | 1. Policy Service Instance | 2. Service Instance Endpoint | 3. Virtual Endpoint | 4. Policy Service Chain", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 1, 
      "required": false, 
      "title": "List of redirect to target paths", 
      "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"
    }, 
    "rule_count": {
      "description": "The count of rules in the policy.", 
      "readonly": true, 
      "title": "Rule count", 
      "type": "int"
    }, 
    "rules": {
      "description": "Redirection rules that are a part of this RedirectionPolicy. At max, there can be 1000 rules in a given RedirectPolicy.", 
      "items": {
        "$ref": "RedirectionRule
      }, 
      "maxItems": 1000, 
      "required": false, 
      "title": "Redirection rules that are a part of this RedirectionPolicy", 
      "type": "array"
    }, 
    "scheduler_path": {
      "description": "Provides a mechanism to apply the rules in this policy for a specified time duration.", 
      "readonly": false, 
      "required": false, 
      "title": "Path to the scheduler for time based scheduling", 
      "type": "string"
    }, 
    "scope": {
      "description": "The list of group paths where the rules in this policy will get applied. This scope will take precedence over rule level scope. Supported only for security and redirection policies. In case of RedirectionPolicy, it is expected only when the policy is NS and redirecting to service chain.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 128, 
      "required": false, 
      "type": "array"
    }, 
    "sequence_number": {
      "description": "This field is used to resolve conflicts between security policies across domains. In order to change the sequence number of a policy one can fire a POST request on the policy entity with a query parameter action=revise The sequence number field will reflect the value of the computed sequence number upon execution of the above mentioned POST request. For scenarios where the administrator is using a template to update several security policies, the only way to set the sequence number is to explicitly specify the sequence number for each security policy. If no sequence number is specified in the payload, a value of 0 is assigned by default. If there are multiple policies with the same sequence number then their order is not deterministic. If a specific order of policies is desired, then one has to specify unique sequence numbers or use the POST request on the policy entity with a query parameter action=revise to let the framework assign a sequence number", 
      "minimum": 0, 
      "title": "Sequence number to resolve conflicts across Domains", 
      "type": "int"
    }, 
    "stateful": {
      "description": "Stateful or Stateless nature of security policy is enforced on all rules in this security policy. When it is stateful, the state of the network connects are tracked and a stateful packet inspection is performed. Layer3 security policies can be stateful or stateless. By default, they are stateful. Layer2 security policies can only be stateless.", 
      "readonly": false, 
      "required": false, 
      "title": "Stateful nature of the entries within this security policy.", 
      "type": "boolean"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "tcp_strict": {
      "description": "Ensures that a 3 way TCP handshake is done before the data packets are sent. tcp_strict=true is supported only for stateful security policies. If the tcp_strict flag is not specified and the security policy is stateful, then tcp_strict will be set to true.", 
      "readonly": false, 
      "required": false, 
      "title": "Enforce strict tcp handshake before allowing data packets", 
      "type": "boolean"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Contains ordered list of rules and path to PolicyServiceInstance\n", 
  "type": "object"
}

RedirectionRule (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "BaseRule
  }, 
  "id": "RedirectionRule", 
  "module_id": "PolicyServiceInsertion", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "action": {
      "description": "The action to be applied to all the services", 
      "enum": [
        "REDIRECT", 
        "DO_NOT_REDIRECT"
      ], 
      "required": false, 
      "title": "Action", 
      "type": "string"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "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 domains. Along with paths we support IP Address of type IPv4 and IPv6. IP Address can be in one of the format(CIDR, IP Address, Range of IP Address). 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.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 128, 
      "required": false, 
      "title": "Destination group paths", 
      "type": "array"
    }, 
    "destinations_excluded": {
      "default": false, 
      "description": "If set to true, the rule gets applied on all the groups that are NOT part of the destination groups. If false, the rule applies to the destination groups", 
      "readonly": false, 
      "required": false, 
      "title": "Negation of destination groups", 
      "type": "boolean"
    }, 
    "direction": {
      "default": "IN_OUT", 
      "description": "Define direction of traffic.", 
      "enum": [
        "IN", 
        "OUT", 
        "IN_OUT"
      ], 
      "required": false, 
      "title": "Direction", 
      "type": "string"
    }, 
    "disabled": {
      "default": false, 
      "description": "Flag to disable the rule. Default is enabled.", 
      "readonly": false, 
      "required": false, 
      "title": "Flag to disable the rule", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ip_protocol": {
      "description": "Type of IP packet that should be matched while enforcing the rule. The value is set to IPV4_IPV6 for Layer3 rule if not specified. For Layer2/Ether rule the value must be null.", 
      "enum": [
        "IPV4", 
        "IPV6", 
        "IPV4_IPV6"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "IPv4 vs IPv6 packet type", 
      "type": "string"
    }, 
    "is_default": {
      "description": "A flag to indicate whether rule is a default rule.", 
      "readonly": true, 
      "required": false, 
      "title": "Default rule flag", 
      "type": "boolean"
    }, 
    "logged": {
      "default": false, 
      "description": "Flag to enable packet logging. Default is disabled.", 
      "readonly": false, 
      "required": false, 
      "title": "Enable logging flag", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "notes": {
      "description": "Text for additional notes on changes.", 
      "maxLength": 2048, 
      "readonly": false, 
      "required": false, 
      "title": "Text for additional notes on changes", 
      "type": "string"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "profiles": {
      "description": "Holds the list of layer 7 service profile paths. These profiles accept attributes and sub-attributes of various network services (e.g. L4 AppId, encryption algorithm, domain name, etc) as key value pairs.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 128, 
      "required": false, 
      "title": "Layer 7 service profiles", 
      "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"
    }, 
    "rule_id": {
      "description": "This is a unique 4 byte positive number that is assigned by the system.  This rule id is passed all the way down to the data path. The first 1GB (1000 to 2^30) will be shared by GM and LM with zebra style striped number space. For E.g 1000 to (1Million -1) by LM, (1M - 2M-1) by GM and so on.", 
      "readonly": true, 
      "required": false, 
      "title": "Unique rule ID", 
      "type": "integer"
    }, 
    "scope": {
      "description": "The list of policy paths where the rule is applied LR/Edge/T0/T1/LRP etc. Note that a given rule can be applied on multiple LRs/LRPs.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 128, 
      "required": false, 
      "type": "array"
    }, 
    "sequence_number": {
      "description": "This field is used to resolve conflicts between multiple Rules under Security or Gateway Policy for a Domain If no sequence number is specified in the payload, a value of 0 is assigned by default. If there are multiple rules with the same sequence number then their order is not deterministic. If a specific order of rules is desired, then one has to specify unique sequence numbers or use the POST request on the rule entity with a query parameter action=revise to let the framework assign a sequence number", 
      "minimum": 0, 
      "required": false, 
      "title": "Sequence number of the this Rule", 
      "type": "int"
    }, 
    "service_entries": {
      "description": "In order to specify raw services this can be used, along with services which contains path to services. This can be empty or null.", 
      "items": {
        "$ref": "ServiceEntry
      }, 
      "maxItems": 128, 
      "required": false, 
      "title": "Raw services", 
      "type": "array"
    }, 
    "services": {
      "description": "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.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 128, 
      "required": false, 
      "title": "Names of services", 
      "type": "array"
    }, 
    "source_groups": {
      "description": "We need paths as duplicate names may exist for groups under different domains. Along with paths we support IP Address of type IPv4 and IPv6. IP Address can be in one of the format(CIDR, IP Address, Range of IP Address). 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.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 128, 
      "required": false, 
      "title": "Source group paths", 
      "type": "array"
    }, 
    "sources_excluded": {
      "default": false, 
      "description": "If set to true, the rule gets applied on all the groups that are NOT part of the source groups. If false, the rule applies to the source groups", 
      "readonly": false, 
      "required": false, 
      "title": "Negation of source groups", 
      "type": "boolean"
    }, 
    "tag": {
      "description": "User level field which will be printed in CLI and packet logs.", 
      "required": false, 
      "title": "Tag applied on the rule", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "It define redirection rule for service insertion", 
  "type": "object"
}

RegistrationToken (type)

{
  "id": "RegistrationToken", 
  "module_id": "RegistrationTokenEndPoint", 
  "properties": {
    "roles": {
      "items": {
        "type": "string"
      }, 
      "required": true, 
      "title": "List results", 
      "type": "array"
    }, 
    "token": {
      "required": true, 
      "sensitive": true, 
      "title": "Access token", 
      "type": "string"
    }, 
    "user": {
      "required": false, 
      "title": "User delegated by token", 
      "type": "string"
    }
  }, 
  "title": "Appliance registration access token", 
  "type": "object"
}

RelatedApiError (type)

{
  "id": "RelatedApiError", 
  "module_id": "Common", 
  "properties": {
    "details": {
      "title": "Further details about the error", 
      "type": "string"
    }, 
    "error_code": {
      "title": "A numeric error code", 
      "type": "integer"
    }, 
    "error_data": {
      "title": "Additional data about the error", 
      "type": "object"
    }, 
    "error_message": {
      "title": "A description of the error", 
      "type": "string"
    }, 
    "module_name": {
      "title": "The module name where the error occurred", 
      "type": "string"
    }
  }, 
  "title": "Detailed information about a related API error", 
  "type": "object"
}

RelatedAttribute (type)

{
  "additionalProperties": false, 
  "description": "Related attribute on the target resource for conditional constraints based on related attribute value. Example - destinationGroups/service/action is related attribute of   sourceGroups in communcation entry.", 
  "id": "RelatedAttribute", 
  "module_id": "PolicyConstraints", 
  "properties": {
    "attribute": {
      "required": true, 
      "title": "Related attribute name on the target entity.", 
      "type": "string"
    }
  }, 
  "title": "Related attribute details.", 
  "type": "object"
}

RelatedAttributeConditionalExpression (type)

{
  "additionalProperties": false, 
  "description": "Represents the leaf level type expression to express constraint as value of realted attribute to the target. Example - Constraint traget attribute 'X' (example in Constraint),   if destinationGroups contains 'vCeneter' then allow only values   \"HTTPS\", \"HTTP\" for attribute X.   {     \"target\":{       \"target_resource_type\":\"CommunicationEntry\",       \"attribute\":\"services\",       \"path_prefix\": \"/infra/domains/{{DOMAIN}}/edge-communication-maps/default/communication-entries/\"     },     \"constraint_expression\": {       \"resource_type\": \"RelatedAttributeConditionalExpression\",       \"related_attribute\":{         \"attribute\":\"destinationGroups\"       },       \"condition\" : {         \"operator\":\"INCLUDES\",         \"rhs_value\": [\"/infra/domains/mgw/groups/VCENTER\"],         \"value_constraint\": {           \"resource_type\": \"ValueConstraintExpression\",           \"operator\":\"INCLUDES\",           \"values\":[\"/infra/services/HTTP\", \"/infra/services/HTTPS\"]         }       }     }   }", 
  "extends": {
    "$ref": "ConstraintExpression
  }, 
  "id": "RelatedAttributeConditionalExpression", 
  "module_id": "PolicyConstraints", 
  "polymorphic-type-descriptor": {
    "type-identifier": "RelatedAttributeConditionalExpression"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "condition": {
      "$ref": "ConditionalValueConstraintExpression, 
      "description": "Conditional value expression for target based on realted attribute value.", 
      "required": true, 
      "title": "Conditiona value constraint expression."
    }, 
    "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "related_attribute": {
      "$ref": "RelatedAttribute, 
      "required": true, 
      "title": "Related attribute."
    }, 
    "resource_type": {
      "enum": [
        "ValueConstraintExpression", 
        "RelatedAttributeConditionalExpression", 
        "EntityInstanceCountConstraintExpression", 
        "FieldSanityConstraintExpression"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Represents the leaf level type expression to express constraint as\nvalue of realted attribute to the target. Uses\nConditionalValueConstraintExpression to constrain the target value\nbased on the related attribute value on the same resource.\n", 
  "type": "object"
}

RemainingSupportBundleNode (type)

{
  "additionalProperties": false, 
  "id": "RemainingSupportBundleNode", 
  "properties": {
    "node_display_name": {
      "readonly": true, 
      "required": true, 
      "title": "Display name of node", 
      "type": "string"
    }, 
    "node_id": {
      "readonly": true, 
      "required": true, 
      "title": "UUID of node", 
      "type": "string"
    }, 
    "status": {
      "enum": [
        "PENDING", 
        "PROCESSING"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Status of node", 
      "type": "string"
    }
  }, 
  "type": "object"
}

RemoteFileServer (type)

{
  "additionalProperties": false, 
  "id": "RemoteFileServer", 
  "module_id": "BackupConfiguration", 
  "properties": {
    "directory_path": {
      "pattern": "^\\/[\\w\\-.\\+~%\\/]+$", 
      "required": true, 
      "title": "Remote server directory to copy bundle files to", 
      "type": "string", 
      "validation_msg_key": "com.vmware.nsx.validation.constraints.BackupRestore.directory_path_pattern.message"
    }, 
    "port": {
      "default": 22, 
      "maximum": 65535, 
      "minimum": 1, 
      "title": "Server port", 
      "type": "integer"
    }, 
    "protocol": {
      "$ref": "FileTransferProtocol, 
      "required": true, 
      "title": "Protocol to use to copy file"
    }, 
    "server": {
      "format": "hostname-or-ip", 
      "required": true, 
      "title": "Remote server hostname or IP address", 
      "type": "string"
    }
  }, 
  "title": "Remote file server", 
  "type": "object"
}

RemoteServerFingerprint (type)

{
  "additionalProperties": false, 
  "id": "RemoteServerFingerprint", 
  "module_id": "BackupConfiguration", 
  "properties": {
    "port": {
      "default": 22, 
      "maximum": 65535, 
      "minimum": 1, 
      "title": "Server port", 
      "type": "integer"
    }, 
    "server": {
      "format": "hostname-or-ip", 
      "required": true, 
      "title": "Remote server hostname or IP address", 
      "type": "string"
    }, 
    "ssh_fingerprint": {
      "required": true, 
      "title": "SSH fingerprint of server", 
      "type": "string"
    }
  }, 
  "title": "Remote server", 
  "type": "object"
}

RemoteServerFingerprintRequest (type)

{
  "additionalProperties": false, 
  "id": "RemoteServerFingerprintRequest", 
  "module_id": "BackupConfiguration", 
  "properties": {
    "port": {
      "default": 22, 
      "maximum": 65535, 
      "minimum": 1, 
      "title": "Server port", 
      "type": "integer"
    }, 
    "server": {
      "format": "hostname-or-ip", 
      "required": true, 
      "title": "Remote server hostname or IP address", 
      "type": "string"
    }
  }, 
  "title": "Remote server", 
  "type": "object"
}

RenderConfiguration (type)

{
  "additionalProperties": false, 
  "description": "Render configuration to be applied to the widget.", 
  "id": "RenderConfiguration", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "properties": {
    "color": {
      "description": "The color to use when rendering an entity. For example, set color as 'RED' to render a portion of donut in red.", 
      "enum": [
        "GREY", 
        "DARK_GREY", 
        "LIGHT_GREY", 
        "SKY_BLUE", 
        "BLUE", 
        "GREEN", 
        "YELLOW", 
        "RED", 
        "DARK_RED"
      ], 
      "title": "Color of the entity", 
      "type": "string"
    }, 
    "condition": {
      "description": "If the condition is met then the rendering specified for the condition will be applied. Examples of expression syntax are provided under 'example_request' section of 'CreateWidgetConfiguration' API.", 
      "maxLength": 1024, 
      "title": "Expression for evaluating condition", 
      "type": "string"
    }, 
    "display_value": {
      "description": "If specified, overrides the field value. This can be used to display a meaningful value in situations where field value is not available or not configured.", 
      "maxLength": 255, 
      "title": "Overridden value to display, if any", 
      "type": "string"
    }, 
    "icons": {
      "description": "Icons to be applied at dashboard for widgets and UI elements.", 
      "items": {
        "$ref": "Icon
      }, 
      "minItems": 0, 
      "title": "Icons", 
      "type": "array"
    }, 
    "tooltip": {
      "description": "Multi-line text to be shown on tooltip while hovering over the UI element if the condition is met.", 
      "items": {
        "$ref": "Tooltip
      }, 
      "minItems": 0, 
      "title": "Multi-line tooltip", 
      "type": "array"
    }
  }, 
  "title": "Render Configuration", 
  "type": "object"
}

ReorderRequest (type)

{
  "additionalProperties": false, 
  "id": "ReorderRequest", 
  "module_id": "Upgrade", 
  "properties": {
    "id": {
      "readonly": false, 
      "required": true, 
      "title": "id of the upgrade unit group/upgrade unit before/after which the upgrade unit group/upgrade unit is to be placed", 
      "type": "string"
    }, 
    "is_before": {
      "default": true, 
      "readonly": false, 
      "required": false, 
      "title": "flag indicating whether the upgrade unit group/upgrade unit is to be placed before or after the specified upgrade unit group/upgrade unit", 
      "type": "boolean"
    }
  }, 
  "type": "object"
}

ResetStatsRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "Request parameters that represents an enforcement point path and category. A request on statistics can be parameterized with this  enforcement point path and will be evaluated as follows: - no enforcement point path specified: the request is evaluated on all enforcement points. - {enforcement_point_path}: the request is evaluated only on the given enforcement point.", 
  "extends": {
    "$ref": "StatisticsRequestParameters
  }, 
  "id": "ResetStatsRequestParameters", 
  "module_id": "PolicyBaseStatistics", 
  "properties": {
    "category": {
      "description": "Aggregation statistic category to perform reset operation.", 
      "enum": [
        "DFW", 
        "EDGE"
      ], 
      "required": true, 
      "title": "Aggregation statistic category", 
      "type": "string"
    }, 
    "enforcement_point_path": {
      "description": "enforcement point path, forward slashes must be escaped using %2F.", 
      "required": false, 
      "title": "String Path of the enforcement point", 
      "type": "string"
    }
  }, 
  "title": "Reset Statistics Request Parameters", 
  "type": "object"
}

Resource (type)

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

ResourceFieldPointer (type)

{
  "additionalProperties": false, 
  "description": "Resource Field Pointer representing the exact value within a policy object.", 
  "id": "ResourceFieldPointer", 
  "module_id": "PolicyReaction", 
  "properties": {
    "field_pointer": {
      "description": "Field Pointer referencing the exact field within the policy object.", 
      "required": true, 
      "title": "Field Pointer", 
      "type": "string"
    }, 
    "path": {
      "description": "Policy Path referencing a policy object. If not supplied, the field pointer will be applied to the event source.", 
      "title": "Resource Path", 
      "type": "string"
    }
  }, 
  "title": "Resource Field Pointer", 
  "type": "object"
}

ResourceInfoListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ResourceInfoListResult", 
  "module_id": "PolicyFineTuning", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "PolicyFineTuningResourceInfo
      }, 
      "required": true, 
      "title": "Resource info list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Collection of resource info objects", 
  "type": "object"
}

ResourceInfoSearchParameters (type)

{
  "additionalProperties": false, 
  "description": "This object presents additional search capabilities over any API through free text query string. e.g. type=\"FirewallRuleDto\".", 
  "experimental": true, 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "ResourceInfoSearchParameters", 
  "module_id": "PolicyFineTuning", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "type": {
      "required": false, 
      "title": "Type query", 
      "type": "string"
    }
  }, 
  "title": "Represents search object that provides additional search capabilities", 
  "type": "object"
}

ResourceLink (type)

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

ResourceOperation (type)

{
  "additionalProperties": false, 
  "description": "Resource Operation is an Event Source that represents a resource that is being changed at very specific points of time, with regard to its interaction with dao layer.", 
  "extends": {
    "$ref": "Source
  }, 
  "id": "ResourceOperation", 
  "module_id": "PolicyReaction", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ResourceOperation"
  }, 
  "properties": {
    "operation_types": {
      "description": "Operation types.", 
      "items": {
        "$ref": "ResourceOperationType
      }, 
      "minItems": 1, 
      "required": true, 
      "title": "Operation Types", 
      "type": "array"
    }, 
    "resource_pointer": {
      "description": "Regex path representing a regex expression on resources. This regex is used to identify the object(s) that is/are the source of the Event. For instance: specifying \"Lb* | /infra/tier-0s/vmc/ipsec-vpn-services/default\" as a source means that ANY resource starting with Lb or ANY resource with \"/infra/tier-0s/vmc/ipsec-vpn-services/default\" as path would be the source of the event in question.", 
      "required": true, 
      "title": "Resource Pointer", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "Event Source resource type.", 
      "enum": [
        "ResourceOperation", 
        "ApiRequestBody"
      ], 
      "required": true, 
      "title": "Resource Type", 
      "type": "string"
    }
  }, 
  "title": "Resource Operation", 
  "type": "object"
}

ResourceOperationType (type)

{
  "additionalProperties": false, 
  "description": "Resource Operation Type represents a change in state of a resource with regard to the interaction with DAO layer: POST_CREATE: post-create change event. POST_UPDATE: post-update change event. PRE_DELETE: pre-delete change event.", 
  "enum": [
    "POST_CREATE", 
    "POST_UPDATE", 
    "PRE_DELETE"
  ], 
  "id": "ResourceOperationType", 
  "module_id": "PolicyReaction", 
  "title": "Resource Operation Type", 
  "type": "string"
}

ResourceReference (type)

{
  "description": "A weak reference to an NSX resource.", 
  "id": "ResourceReference", 
  "module_id": "Common", 
  "properties": {
    "is_valid": {
      "description": "Will be set to false if the referenced NSX resource has been deleted.", 
      "readonly": true, 
      "required": false, 
      "title": "Target validity", 
      "type": "boolean"
    }, 
    "target_display_name": {
      "description": "Display name of the NSX resource.", 
      "maxLength": 255, 
      "readonly": true, 
      "required": false, 
      "title": "Target display name", 
      "type": "string"
    }, 
    "target_id": {
      "description": "Identifier of the NSX resource.", 
      "maxLength": 64, 
      "readonly": false, 
      "required": false, 
      "title": "Target ID", 
      "type": "string"
    }, 
    "target_type": {
      "description": "Type of the NSX resource.", 
      "maxLength": 255, 
      "readonly": false, 
      "required": false, 
      "title": "Target type", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ResourceSummaryDetail (type)

{
  "additionalProperties": false, 
  "description": "Resource summary details represents list of resources for given resource type with its total count.", 
  "id": "ResourceSummaryDetail", 
  "module_id": "GmConfigOnboarding", 
  "properties": {
    "resource_count": {
      "description": "Total resource count", 
      "readonly": true, 
      "required": true, 
      "title": "Resource count", 
      "type": "integer"
    }, 
    "resource_list": {
      "description": "List of homogenous resources of resource type.", 
      "items": {
        "$ref": "OnboardingAttribute
      }, 
      "maxItems": 100, 
      "readonly": true, 
      "required": false, 
      "title": "Resource List", 
      "type": "array"
    }, 
    "resource_type": {
      "description": "Policy resource entity type, for example: CommunicationMap, Group etc.", 
      "readonly": true, 
      "required": true, 
      "title": "Policy Resource Type", 
      "type": "string"
    }
  }, 
  "title": "Resource Summary Detail", 
  "type": "object"
}

RestoreStep (type)

{
  "id": "RestoreStep", 
  "module_id": "ClusterRestore", 
  "properties": {
    "description": {
      "readonly": true, 
      "required": true, 
      "title": "Restore step description", 
      "type": "string"
    }, 
    "status": {
      "$ref": "PerStepRestoreStatus
    }, 
    "step_number": {
      "readonly": true, 
      "required": true, 
      "title": "Restore step number", 
      "type": "integer"
    }, 
    "value": {
      "readonly": true, 
      "required": true, 
      "title": "Restore step value", 
      "type": "string"
    }
  }, 
  "title": "Restore step info", 
  "type": "object"
}

RevisionedResource (type)

{
  "abstract": true, 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "RevisionedResource", 
  "module_id": "Common", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }
  }, 
  "title": "A base class for types that track revisions", 
  "type": "object"
}

Role (type)

{
  "id": "Role", 
  "module_id": "AAA", 
  "properties": {
    "role": {
      "description": "Short identifier for the role. Must be all lower case with no spaces.", 
      "pattern": "^[_a-z0-9-]+$", 
      "required": true, 
      "title": "Role identifier", 
      "type": "string"
    }, 
    "role_display_name": {
      "description": "A short, human-friendly display name of the role.", 
      "required": false, 
      "title": "Display name for role", 
      "type": "string"
    }
  }, 
  "title": "Role", 
  "type": "object"
}

RoleBinding (type)

{
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "RoleBinding", 
  "module_id": "AAA", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "identity_source_id": {
      "description": "The ID of the external identity source that holds the referenced external entity. Currently, only external LDAP and OIDC servers are allowed.", 
      "required": false, 
      "title": "ID of the external identity source", 
      "type": "string"
    }, 
    "identity_source_type": {
      "default": "VIDM", 
      "enum": [
        "VIDM", 
        "LDAP", 
        "OIDC"
      ], 
      "required": false, 
      "title": "Identity source type", 
      "type": "string"
    }, 
    "name": {
      "readonly": true, 
      "required": true, 
      "title": "User/Group's name", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "roles": {
      "items": {
        "$ref": "Role
      }, 
      "readonly": true, 
      "required": true, 
      "title": "Roles", 
      "type": "array"
    }, 
    "stale": {
      "description": "Property 'stale' can be considered to have these values - absent  - This type of rolebinding does not support stale property TRUE    - Rolebinding is stale in vIDM meaning the user is no longer present in vIDM FALSE   - Rolebinding is available in vIDM UNKNOWN - Rolebinding's state of staleness in unknown Once rolebindings become stale, they can be deleted using the API POST /aaa/role-bindings?action=delete_stale_bindings", 
      "enum": [
        "TRUE", 
        "FALSE", 
        "UNKNOWN"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Stale in vIDM", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "type": {
      "enum": [
        "remote_user", 
        "remote_group", 
        "local_user", 
        "principal_identity"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Type", 
      "type": "string"
    }
  }, 
  "title": "User/Group's role binding", 
  "type": "object"
}

RoleBindingListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "RoleBindingListResult", 
  "module_id": "AAA", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "RoleBinding
      }, 
      "required": true, 
      "title": "List results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

RoleBindingRequestParameters (type)

{
  "description": "Pagination and Filtering parameters to get only a subset of users/groups.", 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "RoleBindingRequestParameters", 
  "module_id": "AAA", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "identity_source_id": {
      "description": "If provided, only return role bindings for the given identity source. Currently only supported for LDAP and OIDC identity source types.", 
      "required": false, 
      "title": "Identity source ID", 
      "type": "string"
    }, 
    "identity_source_type": {
      "enum": [
        "VIDM", 
        "LDAP", 
        "OIDC"
      ], 
      "required": false, 
      "title": "Identity source type", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "name": {
      "required": false, 
      "title": "User/Group name", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "role": {
      "required": false, 
      "title": "Role ID", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "type": {
      "enum": [
        "remote_user", 
        "remote_group", 
        "local_user", 
        "principal_identity"
      ], 
      "required": false, 
      "title": "Type", 
      "type": "string"
    }
  }, 
  "title": "Parameters to filter list of role bindings.", 
  "type": "object"
}

RoleListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "RoleListResult", 
  "module_id": "AAA", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "Role
      }, 
      "required": true, 
      "title": "List results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

RoleWithFeatures (type)

{
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "RoleWithFeatures", 
  "module_id": "AAA", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "features": {
      "items": {
        "$ref": "FeaturePermission
      }, 
      "required": true, 
      "title": "Features", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "role": {
      "description": "Short identifier for the role. Must be all lower case with no spaces.", 
      "pattern": "^[_a-z0-9-]+$", 
      "readonly": true, 
      "required": true, 
      "title": "Role identifier", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Role", 
  "type": "object"
}

RoleWithFeaturesListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "RoleWithFeaturesListResult", 
  "module_id": "AAA", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "RoleWithFeatures
      }, 
      "required": true, 
      "title": "List results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

RouteAdvertisementRule (type)

{
  "additionalProperties": false, 
  "id": "RouteAdvertisementRule", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "action": {
      "default": "PERMIT", 
      "description": "Action to advertise filtered routes to the connected Tier0 gateway. PERMIT: Enables the advertisment DENY: Disables the advertisement", 
      "enum": [
        "PERMIT", 
        "DENY"
      ], 
      "required": true, 
      "title": "Action to advertise routes", 
      "type": "string"
    }, 
    "name": {
      "description": "Display name should be unique.", 
      "required": true, 
      "title": "Display name for rule", 
      "type": "string"
    }, 
    "prefix_operator": {
      "default": "GE", 
      "description": "Prefix operator to filter subnets. GE prefix operator filters all the routes with prefix length greater than or equal to the subnets configured. EQ prefix operator filter all the routes with prefix length equal to the subnets configured.", 
      "enum": [
        "GE", 
        "EQ"
      ], 
      "required": false, 
      "title": "Prefix operator to match subnets", 
      "type": "string"
    }, 
    "route_advertisement_types": {
      "description": "Enable different types of route advertisements. When not specified, routes to IPSec VPN local-endpoint subnets (TIER1_IPSEC_LOCAL_ENDPOINT) are automatically advertised.", 
      "items": {
        "$ref": "Tier1RouteAdvertisentTypes
      }, 
      "required": false, 
      "title": "Enable different types of route advertisements", 
      "type": "array"
    }, 
    "subnets": {
      "description": "Network CIDRs to be routed.", 
      "items": {
        "format": "ip-cidr-block", 
        "type": "string"
      }, 
      "required": false, 
      "title": "Network CIDRs", 
      "type": "array"
    }
  }, 
  "title": "Route advertisement rules and filtering", 
  "type": "object"
}

RouteAggregationEntry (type)

{
  "additionalProperties": false, 
  "id": "RouteAggregationEntry", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "prefix": {
      "description": "CIDR of aggregate address", 
      "format": "ip-cidr-block", 
      "required": true, 
      "title": "CIDR of aggregate address", 
      "type": "string"
    }, 
    "summary_only": {
      "default": true, 
      "description": "Send only summarized route. Summarization reduces number of routes advertised by representing multiple related routes with prefix property.", 
      "required": false, 
      "title": "Send only summarized route", 
      "type": "boolean"
    }
  }, 
  "title": "List of routes to be aggregated", 
  "type": "object"
}

RouteBasedIPSecVpnSession (type)

{
  "additionalProperties": false, 
  "description": "A Route Based VPN is more flexible, more powerful and recommended over policy based VPN. IP Tunnel port is created and all traffic routed via tunnel port is protected. Routes can be configured statically or can be learned through BGP. A route based VPN is must for establishing redundant VPN session to remote site.", 
  "extends": {
    "$ref": "IPSecVpnSession
  }, 
  "id": "RouteBasedIPSecVpnSession", 
  "module_id": "PolicyIPSecVpn", 
  "polymorphic-type-descriptor": {
    "type-identifier": "RouteBasedIPSecVpnSession"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "authentication_mode": {
      "default": "PSK", 
      "description": "Peer authentication mode. PSK - In this mode a secret key shared between local and peer sites is to be used for authentication. The secret key can be a string with a maximum length of 128 characters. CERTIFICATE - In this mode a certificate defined at the global level is to be used for authentication.", 
      "enum": [
        "PSK", 
        "CERTIFICATE"
      ], 
      "title": "Authentication Mode", 
      "type": "string"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "compliance_suite": {
      "description": "Compliance suite.", 
      "enum": [
        "CNSA", 
        "SUITE_B_GCM_128", 
        "SUITE_B_GCM_256", 
        "PRIME", 
        "FOUNDATION", 
        "FIPS", 
        "NONE"
      ], 
      "title": "Compliance suite", 
      "type": "string"
    }, 
    "connection_initiation_mode": {
      "default": "INITIATOR", 
      "description": "Connection initiation mode used by local endpoint to establish ike connection with peer site. INITIATOR - In this mode local endpoint initiates tunnel setup and will also respond to incoming tunnel setup requests from peer gateway. RESPOND_ONLY - In this mode, local endpoint shall only respond to incoming tunnel setup requests. It shall not initiate the tunnel setup. ON_DEMAND - In this mode local endpoint will initiate tunnel creation once first packet matching the policy rule is received and will also respond to incoming initiation request.", 
      "enum": [
        "INITIATOR", 
        "RESPOND_ONLY", 
        "ON_DEMAND"
      ], 
      "title": "Connection initiation mode", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "dpd_profile_path": {
      "description": "Policy path referencing Dead Peer Detection (DPD) profile. Default is set to system default profile.", 
      "title": "Dead peer detection (DPD) profile path", 
      "type": "string"
    }, 
    "enabled": {
      "default": true, 
      "description": "Enable/Disable IPSec VPN session.", 
      "title": "Enable/Disable IPSec VPN session", 
      "type": "boolean"
    }, 
    "force_whitelisting": {
      "default": false, 
      "deprecated": true, 
      "description": "If true the default firewall rule Action is set to DROP, otherwise set to ALLOW. This filed is deprecated and recommended to change Rule action filed. Note that this filed is not synchornied with default rule field.", 
      "required": false, 
      "title": "Flag to add default whitelisting Gateway Policy rule for the VTI interface.", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ike_profile_path": {
      "description": "Policy path referencing IKE profile to be used. Default is set according to system default profile.", 
      "title": "Internet key exchange (IKE) profile path", 
      "type": "string"
    }, 
    "local_endpoint_path": {
      "description": "Policy path referencing Local endpoint.", 
      "required": true, 
      "title": "Local endpoint path", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "peer_address": {
      "description": "Public IPV4 address of the remote device terminating the VPN connection.", 
      "required": true, 
      "title": "IPV4 address of peer endpoint on remote site", 
      "type": "string"
    }, 
    "peer_id": {
      "description": "Peer ID to uniquely identify the peer site. The peer ID is the public IP address of the remote device terminating the VPN tunnel. When NAT is configured for the peer, enter the private IP address of the peer.", 
      "required": true, 
      "title": "Peer id", 
      "type": "string"
    }, 
    "psk": {
      "description": "IPSec Pre-shared key. Maximum length of this field is 128 characters.", 
      "sensitive": true, 
      "title": "Pre-shared key", 
      "type": "string"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "$ref": "IPSecVpnSessionResourceType, 
      "required": true
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "tcp_mss_clamping": {
      "$ref": "TcpMaximumSegmentSizeClamping, 
      "description": "TCP Maximum Segment Size Clamping Direction and Value.", 
      "title": "TCP MSS Clamping"
    }, 
    "tunnel_interfaces": {
      "description": "IP Tunnel interfaces.", 
      "items": {
        "$ref": "IPSecVpnTunnelInterface
      }, 
      "maxItems": 1, 
      "minItems": 1, 
      "required": true, 
      "title": "IP Tunnel interfaces", 
      "type": "array"
    }, 
    "tunnel_profile_path": {
      "description": "Policy path referencing Tunnel profile to be used. Default is set to system default profile.", 
      "title": "IPSec tunnel profile path", 
      "type": "string"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Route based VPN session", 
  "type": "object"
}

RouteBasedL3VpnSession (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "description": "A Route Based L3Vpn is more flexible, more powerful and recommended over policy based. IP Tunnel subnet is created and all traffic routed through tunnel subnet is sent over tunnel. Routes can be learned through BGP. A route based L3Vpn is required when using redundant L3Vpn.", 
  "extends": {
    "$ref": "L3VpnSession
  }, 
  "id": "RouteBasedL3VpnSession", 
  "module_id": "PolicyL3Vpn", 
  "polymorphic-type-descriptor": {
    "type-identifier": "RouteBasedL3VpnSession"
  }, 
  "properties": {
    "default_rule_logging": {
      "default": false, 
      "description": "Indicates if logging should be enabled for the default whitelisting rule for the VTI interface.", 
      "required": false, 
      "title": "Enable logging for whitelisted rule for the VTI interface", 
      "type": "boolean"
    }, 
    "force_whitelisting": {
      "default": false, 
      "description": "The default firewall rule Action is set to DROP if true otherwise set to ALLOW.", 
      "required": false, 
      "title": "Flag to add default whitelisting FW rule for the VTI interface.", 
      "type": "boolean"
    }, 
    "resource_type": {
      "$ref": "L3VpnSessionResourceType, 
      "required": true
    }, 
    "routing_config_path": {
      "deprecated": true, 
      "description": "This is a deprecated field. Any specified value is not saved and will be ignored.", 
      "title": "Routing configuration policy path", 
      "type": "string"
    }, 
    "tunnel_subnets": {
      "description": "Virtual tunnel interface (VTI) port IP subnets to be used to configure route-based L3Vpn session. A max of one tunnel subnet is allowed.", 
      "items": {
        "$ref": "TunnelSubnet
      }, 
      "maxItems": 1, 
      "minItems": 1, 
      "required": true, 
      "title": "Virtual Tunnel Interface (VTI) IP subnets", 
      "type": "array", 
      "uniqueItems": true
    }
  }, 
  "title": "Route based L3Vpn Session", 
  "type": "object"
}

RouteDetails (type)

{
  "additionalProperties": false, 
  "description": "BGP route details.", 
  "id": "RouteDetails", 
  "module_id": "AggSvcLogicalRouter", 
  "properties": {
    "as_path": {
      "description": "BGP AS path attribute.", 
      "readonly": true, 
      "required": false, 
      "title": "AS path", 
      "type": "string"
    }, 
    "local_pref": {
      "description": "BGP Local Preference attribute.", 
      "readonly": true, 
      "required": false, 
      "title": "Local preference", 
      "type": "integer"
    }, 
    "med": {
      "description": "BGP Multi Exit Discriminator attribute.", 
      "readonly": true, 
      "required": false, 
      "title": "Multi Exit Discriminator", 
      "type": "integer"
    }, 
    "network": {
      "$ref": "IPCIDRBlock, 
      "description": "CIDR network address.", 
      "readonly": true, 
      "required": true, 
      "title": "CIDR network address"
    }, 
    "next_hop": {
      "$ref": "IPAddress, 
      "description": "Next hop IP address.", 
      "readonly": true, 
      "required": false, 
      "title": "Next hop IP address"
    }, 
    "weight": {
      "description": "BGP Weight attribute.", 
      "readonly": true, 
      "required": false, 
      "title": "Weight", 
      "type": "integer"
    }
  }, 
  "title": "BGP route details", 
  "type": "object"
}

RouteMapEntry (type)

{
  "additionalProperties": false, 
  "id": "RouteMapEntry", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "action": {
      "description": "Action for the route map entry", 
      "enum": [
        "PERMIT", 
        "DENY"
      ], 
      "required": true, 
      "title": "Action for the route map entry", 
      "type": "string"
    }, 
    "community_list_matches": {
      "description": "Community list match criteria for route map. Properties community_list_matches and prefix_list_matches are mutually exclusive and cannot be used in the same route map entry.", 
      "items": {
        "$ref": "CommunityMatchCriteria
      }, 
      "required": false, 
      "title": "Community list match criteria", 
      "type": "array"
    }, 
    "prefix_list_matches": {
      "description": "Prefix list match criteria for route map. Properties community_list_matches and prefix_list_matches are mutually exclusive and cannot be used in the same route map entry.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 500, 
      "required": false, 
      "title": "Prefix list match criteria", 
      "type": "array"
    }, 
    "set": {
      "$ref": "RouteMapEntrySet, 
      "description": "Set criteria for route map entry", 
      "required": false, 
      "title": "Set criteria for route map entry"
    }
  }, 
  "title": "Route map entry", 
  "type": "object"
}

RouteMapEntrySet (type)

{
  "additionalProperties": false, 
  "id": "RouteMapEntrySet", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "as_path_prepend": {
      "description": "AS path prepend to influence route selection.", 
      "required": false, 
      "title": "AS path prepend to influence route selection", 
      "type": "string"
    }, 
    "community": {
      "description": "Set BGP regular or large community for matching routes. A maximum of one value for each community type separated by space. Well-known community name, community value in aa:nn (2byte:2byte) format for regular community and community value in aa:bb:nn (4byte:4byte:4byte) format for large community are supported.", 
      "required": false, 
      "title": "Set BGP community", 
      "type": "string"
    }, 
    "local_preference": {
      "default": 100, 
      "description": "Local preference indicates the degree of preference for one BGP route over other BGP routes. The path with highest local preference is preferred.", 
      "maximum": 4294967295, 
      "title": "Local preference to set for matching BGP routes", 
      "type": "integer"
    }, 
    "med": {
      "description": "Multi exit descriminator (MED) is a hint to BGP neighbors about the preferred path into an autonomous system (AS) that has multiple entry points. A lower MED value is preferred over a higher value.", 
      "maximum": 4294967295, 
      "minimum": 0, 
      "required": false, 
      "title": "Multi exit descriminator", 
      "type": "int"
    }, 
    "prefer_global_v6_next_hop": {
      "description": "For incoming and import route_maps on receiving both v6 global and v6 link-local address for the route, prefer to use the global address as the next hop. By default, it prefers the link-local next hop.", 
      "required": false, 
      "title": "Prefer global v6 next hop over local next hop", 
      "type": "boolean"
    }, 
    "weight": {
      "description": "Weight is used to select a route when multiple routes are available to the same network. Route with the highest weight is preferred.", 
      "maximum": 65535, 
      "minimum": 0, 
      "required": false, 
      "title": "Weight used to select certain path", 
      "type": "int"
    }
  }, 
  "title": "Set criteria for route map entry", 
  "type": "object"
}

RouterNexthop (type)

{
  "additionalProperties": false, 
  "id": "RouterNexthop", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "admin_distance": {
      "default": 1, 
      "description": "Cost associated with next hop route", 
      "maximum": 255, 
      "minimum": 1, 
      "required": false, 
      "title": "Cost associated with next hop route", 
      "type": "int"
    }, 
    "ip_address": {
      "$ref": "IPAddress, 
      "description": "Next hop gateway IP address", 
      "required": false, 
      "title": "Next hop gateway IP address"
    }, 
    "scope": {
      "description": "Interface path associated with current route. For example: specify a policy path referencing the IPSec VPN Session.", 
      "items": {
        "type": "string"
      }, 
      "minItems": 1, 
      "required": false, 
      "title": "Interface path associated with current route", 
      "type": "array"
    }
  }, 
  "title": "Next hop configuration for network", 
  "type": "object"
}

RoutesPerTransportNode (type)

{
  "additionalProperties": false, 
  "description": "BGP routes per transport node.", 
  "id": "RoutesPerTransportNode", 
  "module_id": "AggSvcLogicalRouter", 
  "properties": {
    "routes": {
      "description": "Array of BGP neighbor route details for this transport node.", 
      "items": {
        "$ref": "RouteDetails
      }, 
      "readonly": true, 
      "required": false, 
      "title": "BGP neighbor route details", 
      "type": "array"
    }, 
    "source_address": {
      "$ref": "IPAddress, 
      "description": "BGP neighbor source address.", 
      "readonly": true, 
      "required": false, 
      "title": "BGP neighbor source address"
    }, 
    "transport_node_id": {
      "readonly": true, 
      "required": true, 
      "title": "Transport node id", 
      "type": "string"
    }
  }, 
  "title": "Routes per transport node", 
  "type": "object"
}

RoutesRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "BaseListRequestParameters
  }, 
  "id": "RoutesRequestParameters", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "edge_id": {
      "description": "UUID of edge node. Edge should be member of enforcement point.", 
      "title": "UUID of edge node", 
      "type": "string"
    }, 
    "edge_path": {
      "description": "Policy path of edge node. Edge should be member of enforcement point.", 
      "title": "Policy path of edge node", 
      "type": "string"
    }, 
    "enforcement_point_path": {
      "description": "String Path of the enforcement point. When not specified, routes from all enforcement-points are returned. This property is required for retrieving routes in CSV format.", 
      "title": "Enforcement point path", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "network_prefix": {
      "$ref": "IPCIDRBlock, 
      "description": "CIDR network address to filter entries in the table.", 
      "title": "Network address filter parameter"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "route_source": {
      "description": "Filter routes based on the source from which route is learned.", 
      "enum": [
        "BGP", 
        "STATIC", 
        "CONNECTED"
      ], 
      "title": "Filter routes based on the source from which route is learned", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Routes request parameters", 
  "type": "object"
}

RoutingEntry (type)

{
  "additionalProperties": false, 
  "description": "Routing table entry.", 
  "id": "RoutingEntry", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "admin_distance": {
      "description": "Admin distance.", 
      "readonly": true, 
      "title": "Admin distance", 
      "type": "int"
    }, 
    "interface": {
      "required": false, 
      "title": "The policy path of the interface which is used as the next hop", 
      "type": "string"
    }, 
    "lr_component_id": {
      "required": false, 
      "title": "Logical router component(Service Router/Distributed Router) id", 
      "type": "string"
    }, 
    "lr_component_type": {
      "required": false, 
      "title": "Logical router component(Service Router/Distributed Router) type", 
      "type": "string"
    }, 
    "network": {
      "description": "Network CIDR.", 
      "readonly": true, 
      "title": "Network CIDR", 
      "type": "string"
    }, 
    "next_hop": {
      "$ref": "IPAddress, 
      "description": "Next hop address.", 
      "readonly": true, 
      "title": "Next hop address"
    }, 
    "route_type": {
      "description": "Route type in routing table. t0c - Tier-0 Connected t0s - Tier-0 Static b - BGP t0n - Tier-0 NAT t1s - Tier-1 Static t1c - Tier-1 Connected t1n: Tier-1 NAT t1l: Tier-1 LB VIP t1ls: Tier-1 LB SNAT t1d: Tier-1 DNS FORWARDER t1ipsec: Tier-1 IPSec isr: Inter-SR", 
      "readonly": true, 
      "title": "Route type (USER, CONNECTED, NSX_INTERNAL,..)", 
      "type": "string"
    }
  }, 
  "title": "Routing table entry", 
  "type": "object"
}

RoutingTable (type)

{
  "additionalProperties": false, 
  "description": "Routing table.", 
  "id": "RoutingTable", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "count": {
      "description": "Entry count.", 
      "readonly": true, 
      "title": "Entry count", 
      "type": "int"
    }, 
    "edge_node": {
      "description": "Transport node ID.", 
      "readonly": true, 
      "title": "Transport node ID", 
      "type": "string"
    }, 
    "route_entries": {
      "description": "Route entries.", 
      "items": {
        "$ref": "RoutingEntry
      }, 
      "required": true, 
      "title": "Route entries", 
      "type": "array"
    }
  }, 
  "title": "Routing table", 
  "type": "object"
}

RoutingTableListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "RoutingTableListResult", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Paged Collection of Routes per transport node ID.", 
      "items": {
        "$ref": "RoutingTable, 
        "title": "Routing table"
      }, 
      "required": false, 
      "title": "Paged Collection of Routes per transport node ID", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

RowListField (type)

{
  "additionalProperties": false, 
  "description": "Root of the api result set for forming rows.", 
  "id": "RowListField", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "properties": {
    "alias": {
      "description": "Short name or alias of row list field, if any. If unspecified, the row list field can be referenced by its index in the array of row list fields as $<index> (for example, $0).", 
      "maxLength": 255, 
      "title": "Alias Name", 
      "type": "string"
    }, 
    "path": {
      "description": "JSON path to the root of the api result set for forming rows.", 
      "maxLength": 1024, 
      "required": true, 
      "title": "JSON path", 
      "type": "string"
    }
  }, 
  "title": "List of fields from which rows are formed", 
  "type": "object"
}

RpAddressMulticastRanges (type)

{
  "additionalProperties": false, 
  "description": "Static IPv4 multicast address and assciated multicast group ranges.", 
  "id": "RpAddressMulticastRanges", 
  "module_id": "PolicyMulticast", 
  "properties": {
    "multicast_ranges": {
      "description": "Assciated multicast group ranges configuration.", 
      "items": {
        "format": "ip-cidr-block", 
        "type": "string"
      }, 
      "required": false, 
      "title": "Assciated multicast group ranges configuration", 
      "type": "array"
    }, 
    "rp_address": {
      "$ref": "IPAddress, 
      "description": "Static IPv4 multicast address configuration.", 
      "required": true, 
      "title": "Static IPv4 multicast address configuration"
    }
  }, 
  "title": "Static IPv4 multicast address and assciated multicast group ranges", 
  "type": "object"
}

Rule (type)

{
  "additionalProperties": false, 
  "description": "A rule indicates the action to be performed for various types of traffic flowing between workload groups.", 
  "extends": {
    "$ref": "BaseRule
  }, 
  "id": "Rule", 
  "module_id": "Policy", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "action": {
      "description": "The action to be applied to all the services The JUMP_TO_APPLICATION action is only supported for rules created in the Environment category. Once a match is hit then the rule processing will jump to the rules present in the Application category, skipping all further rules in the Environment category. If no rules match in the Application category then the default application rule will be hit. This is applicable only for DFW.", 
      "enum": [
        "ALLOW", 
        "DROP", 
        "REJECT", 
        "JUMP_TO_APPLICATION"
      ], 
      "required": false, 
      "title": "Action", 
      "type": "string"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "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 domains. Along with paths we support IP Address of type IPv4 and IPv6. IP Address can be in one of the format(CIDR, IP Address, Range of IP Address). 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.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 128, 
      "required": false, 
      "title": "Destination group paths", 
      "type": "array"
    }, 
    "destinations_excluded": {
      "default": false, 
      "description": "If set to true, the rule gets applied on all the groups that are NOT part of the destination groups. If false, the rule applies to the destination groups", 
      "readonly": false, 
      "required": false, 
      "title": "Negation of destination groups", 
      "type": "boolean"
    }, 
    "direction": {
      "default": "IN_OUT", 
      "description": "Define direction of traffic.", 
      "enum": [
        "IN", 
        "OUT", 
        "IN_OUT"
      ], 
      "required": false, 
      "title": "Direction", 
      "type": "string"
    }, 
    "disabled": {
      "default": false, 
      "description": "Flag to disable the rule. Default is enabled.", 
      "readonly": false, 
      "required": false, 
      "title": "Flag to disable the rule", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ip_protocol": {
      "description": "Type of IP packet that should be matched while enforcing the rule. The value is set to IPV4_IPV6 for Layer3 rule if not specified. For Layer2/Ether rule the value must be null.", 
      "enum": [
        "IPV4", 
        "IPV6", 
        "IPV4_IPV6"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "IPv4 vs IPv6 packet type", 
      "type": "string"
    }, 
    "is_default": {
      "description": "A flag to indicate whether rule is a default rule.", 
      "readonly": true, 
      "required": false, 
      "title": "Default rule flag", 
      "type": "boolean"
    }, 
    "logged": {
      "default": false, 
      "description": "Flag to enable packet logging. Default is disabled.", 
      "readonly": false, 
      "required": false, 
      "title": "Enable logging flag", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "notes": {
      "description": "Text for additional notes on changes.", 
      "maxLength": 2048, 
      "readonly": false, 
      "required": false, 
      "title": "Text for additional notes on changes", 
      "type": "string"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "profiles": {
      "description": "Holds the list of layer 7 service profile paths. These profiles accept attributes and sub-attributes of various network services (e.g. L4 AppId, encryption algorithm, domain name, etc) as key value pairs.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 128, 
      "required": false, 
      "title": "Layer 7 service profiles", 
      "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"
    }, 
    "rule_id": {
      "description": "This is a unique 4 byte positive number that is assigned by the system.  This rule id is passed all the way down to the data path. The first 1GB (1000 to 2^30) will be shared by GM and LM with zebra style striped number space. For E.g 1000 to (1Million -1) by LM, (1M - 2M-1) by GM and so on.", 
      "readonly": true, 
      "required": false, 
      "title": "Unique rule ID", 
      "type": "integer"
    }, 
    "scope": {
      "description": "The list of policy paths where the rule is applied LR/Edge/T0/T1/LRP etc. Note that a given rule can be applied on multiple LRs/LRPs.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 128, 
      "required": false, 
      "type": "array"
    }, 
    "sequence_number": {
      "description": "This field is used to resolve conflicts between multiple Rules under Security or Gateway Policy for a Domain If no sequence number is specified in the payload, a value of 0 is assigned by default. If there are multiple rules with the same sequence number then their order is not deterministic. If a specific order of rules is desired, then one has to specify unique sequence numbers or use the POST request on the rule entity with a query parameter action=revise to let the framework assign a sequence number", 
      "minimum": 0, 
      "required": false, 
      "title": "Sequence number of the this Rule", 
      "type": "int"
    }, 
    "service_entries": {
      "description": "In order to specify raw services this can be used, along with services which contains path to services. This can be empty or null.", 
      "items": {
        "$ref": "ServiceEntry
      }, 
      "maxItems": 128, 
      "required": false, 
      "title": "Raw services", 
      "type": "array"
    }, 
    "services": {
      "description": "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.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 128, 
      "required": false, 
      "title": "Names of services", 
      "type": "array"
    }, 
    "source_groups": {
      "description": "We need paths as duplicate names may exist for groups under different domains. Along with paths we support IP Address of type IPv4 and IPv6. IP Address can be in one of the format(CIDR, IP Address, Range of IP Address). 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.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 128, 
      "required": false, 
      "title": "Source group paths", 
      "type": "array"
    }, 
    "sources_excluded": {
      "default": false, 
      "description": "If set to true, the rule gets applied on all the groups that are NOT part of the source groups. If false, the rule applies to the source groups", 
      "readonly": false, 
      "required": false, 
      "title": "Negation of source groups", 
      "type": "boolean"
    }, 
    "tag": {
      "description": "User level field which will be printed in CLI and packet logs.", 
      "required": false, 
      "title": "Tag applied on the rule", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "A rule specifies the security policy rule between the workload groups", 
  "type": "object"
}

RuleInsertParameters (type)

{
  "description": "Parameters to let the admin specify a relative position of a rule w.r.t to another one in the same security policy. If the rule specified in the anchor_path belongs to another security policy an error will be thrown.", 
  "extends": {
    "$ref": "PolicyInsertParameters
  }, 
  "id": "RuleInsertParameters", 
  "module_id": "Policy", 
  "properties": {
    "anchor_path": {
      "required": false, 
      "title": "The security policy/rule path if operation is 'insert_after' or\n'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 rule needs to be placed", 
  "type": "object"
}

RuleListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "RuleListRequestParameters", 
  "module_id": "Policy", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Rule list request parameters", 
  "type": "object"
}

RuleListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "BaseRuleListResult
  }, 
  "id": "RuleListResult", 
  "module_id": "Policy", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "Rule
      }, 
      "required": true, 
      "title": "Rule list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of Rules", 
  "type": "object"
}

RuleStatistics (type)

{
  "extends": {
    "$ref": "Resource
  }, 
  "id": "RuleStatistics", 
  "module_id": "Policy", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "byte_count": {
      "description": "Aggregated number of bytes processed by the rule.", 
      "readonly": true, 
      "required": false, 
      "title": "Bytes count", 
      "type": "integer"
    }, 
    "hit_count": {
      "description": "Aggregated number of hits received by the rule.", 
      "readonly": true, 
      "required": false, 
      "title": "Hits count", 
      "type": "integer"
    }, 
    "internal_rule_id": {
      "description": "Realized id of the rule on NSX MP. Policy Manager can create more than one rule per policy rule, in which case this identifier helps to distinguish between the multple rules created.", 
      "readonly": true, 
      "required": false, 
      "title": "NSX internal rule id", 
      "type": "string"
    }, 
    "lr_path": {
      "description": "Path of the LR on which the section is applied in case of Edge FW.", 
      "readonly": true, 
      "required": false, 
      "title": "Logical Router (Tier-0/Tier1) path", 
      "type": "string"
    }, 
    "max_popularity_index": {
      "description": "Maximum value of popularity index of all rules of the type. This is aggregated statistic which are computed with lower frequency compared to individual generic rule statistics. It may have a computation delay up to 15 minutes in response to this API.", 
      "readonly": true, 
      "required": false, 
      "title": "The maximum popularity index", 
      "type": "integer"
    }, 
    "max_session_count": {
      "description": "Maximum value of sessions count of all rules of the type. This is aggregated statistic which are computed with lower frequency compared to generic rule statistics. It may have a computation delay up to 15 minutes in response to this API.", 
      "readonly": true, 
      "required": false, 
      "title": "Maximum Sessions count", 
      "type": "integer"
    }, 
    "packet_count": {
      "description": "Aggregated number of packets processed by the rule.", 
      "readonly": true, 
      "required": false, 
      "title": "Packets count", 
      "type": "integer"
    }, 
    "popularity_index": {
      "description": "This is calculated by sessions count divided by age of the rule.", 
      "readonly": true, 
      "required": false, 
      "title": "The index of the popularity of rule", 
      "type": "integer"
    }, 
    "rule": {
      "description": "Path of the rule.", 
      "readonly": true, 
      "required": false, 
      "title": "Rule path", 
      "type": "string"
    }, 
    "session_count": {
      "description": "Aggregated number of sessions processed by the rule.", 
      "readonly": true, 
      "required": false, 
      "title": "sessions count", 
      "type": "integer"
    }, 
    "total_session_count": {
      "description": "Aggregated number of sessions processed by all the rules This is aggregated statistic which are computed with lower frequency compared to individual generic rule  statistics. It may have a computation delay up to 15 minutes in response to this API.", 
      "readonly": true, 
      "required": false, 
      "title": "Total Sessions count", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

RuleStatisticsForEnforcementPoint (type)

{
  "description": "Rule statistics for a specfic enforcement point.", 
  "id": "RuleStatisticsForEnforcementPoint", 
  "module_id": "Policy", 
  "properties": {
    "enforcement_point": {
      "description": "Rule statistics for a single enforcement point", 
      "readonly": true, 
      "required": false, 
      "title": "Enforcement point path", 
      "type": "string"
    }, 
    "statistics": {
      "$ref": "RuleStatistics, 
      "description": "Statistics for the specified enforcement point", 
      "readonly": true, 
      "required": false, 
      "title": "Rule Statistics"
    }
  }, 
  "title": "Rule statistics for an enforcement point", 
  "type": "object"
}

RuleStatisticsListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "RuleStatisticsListResult", 
  "module_id": "Policy", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "RuleStatisticsForEnforcementPoint
      }, 
      "required": true, 
      "title": "RuleStatistics list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of rule statistics", 
  "type": "object"
}

RuntimeState (type)

{
  "additionalProperties": false, 
  "description": "Runtime State.", 
  "enum": [
    "UNINITIALIZED", 
    "UNKNOWN", 
    "UP", 
    "DOWN", 
    "DEGRADED", 
    "SUCCESS", 
    "FAILURE", 
    "IN_PROGRESS"
  ], 
  "id": "RuntimeState", 
  "module_id": "PolicyRealizationStatus", 
  "title": "Runtime State", 
  "type": "string"
}

ScpProtocol (type)

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

SearchQueryRequest (type)

{
  "additionalProperties": false, 
  "description": "Search query request.", 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "SearchQueryRequest", 
  "module_id": "Search", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "query": {
      "description": "The syntax of query is described in Search API documentation.", 
      "required": true, 
      "title": "Search query", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "SearchQueryRequest", 
  "type": "object"
}

SearchResponse (type)

{
  "additionalProperties": false, 
  "description": "Search response", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "SearchResponse", 
  "module_id": "Search", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "List of records matching the search query.", 
      "items": {
        "type": "object"
      }, 
      "readonly": true, 
      "title": "Search results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "SearchResponse", 
  "type": "object"
}

SecurityPolicy (type)

{
  "description": "Ordered list of Rules.", 
  "extends": {
    "$ref": "Policy
  }, 
  "id": "SecurityPolicy", 
  "module_id": "Policy", 
  "policy_hierarchical_children": [
    "ChildRule"
  ], 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "application_connectivity_strategy": {
      "description": "This field indicates the application connectivity policy for the security policy.", 
      "items": {
        "$ref": "ApplicationConnectivityStrategy
      }, 
      "maxItems": 2, 
      "required": false, 
      "title": "List of Application Connectivity strategy for this SecurityPolicy", 
      "type": "array"
    }, 
    "category": {
      "description": "- Distributed Firewall - Policy framework provides five pre-defined categories for classifying a security policy. They are \"Ethernet\",\"Emergency\", \"Infrastructure\" \"Environment\" and \"Application\". There is a pre-determined order in which the policy framework manages the priority of these security policies. Ethernet category is for supporting layer 2 firewall rules. The other four categories are applicable for layer 3 rules. Amongst them, the Emergency category has the highest priority followed by Infrastructure, Environment and then Application rules. Administrator can choose to categorize a security policy into the above categories or can choose to leave it empty. If empty it will have the least precedence w.r.t the above four categories. - Edge Firewall - Policy Framework for Edge Firewall provides six pre-defined categories \"Emergency\", \"SystemRules\", \"SharedPreRules\", \"LocalGatewayRules\", \"AutoServiceRules\" and \"Default\", in order of priority of rules. All categories are allowed for Gatetway Policies that belong to 'default' Domain. However, for user created domains, category is restricted to \"SharedPreRules\" or \"LocalGatewayRules\" only. Also, the users can add/modify/delete rules from only the \"SharedPreRules\" and \"LocalGatewayRules\" categories. If user doesn't specify the category then defaulted to \"Rules\". System generated category is used by NSX created rules, for example BFD rules. Autoplumbed category used by NSX verticals to autoplumb data path rules. Finally, \"Default\" category is the placeholder default rules with lowest in the order of priority.", 
      "required": false, 
      "title": "A way to classify a security policy, if needed.", 
      "type": "string"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "comments": {
      "description": "Comments for security policy lock/unlock.", 
      "readonly": false, 
      "required": false, 
      "title": "SecurityPolicy lock/unlock comments", 
      "type": "string"
    }, 
    "connectivity_strategy": {
      "description": "This field indicates the default connectivity policy for the security policy. Based on the connectivitiy strategy, a default rule for this security policy will be created. An appropriate action will be set on the rule based on the value of the connectivity strategy. If NONE is selected or no connectivity strategy is specified, then no default rule for the security policy gets created. The default rule that gets created will be a any-any rule and applied to entities specified in the scope of the security policy. Specifying the connectivity_strategy without specifying the scope is not allowed. The scope has to be a Group and one cannot specify IPAddress directly in the group that is used as scope. This default rule is only applicable for the Layer3 security policies. 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 WHITELIST_ENABLE_LOGGING - Whitelising with logging enabled BLACKLIST_ENABLE_LOGGING - Blacklisting with logging enabled NONE - No default rule is created.", 
      "enum": [
        "WHITELIST", 
        "BLACKLIST", 
        "WHITELIST_ENABLE_LOGGING", 
        "BLACKLIST_ENABLE_LOGGING", 
        "NONE"
      ], 
      "required": false, 
      "title": "Connectivity strategy applicable for this SecurityPolicy", 
      "type": "string"
    }, 
    "default_rule_id": {
      "description": "Based on the value of the connectivity strategy, a default rule is created for the security policy. The rule id is internally assigned by the system for this default rule.", 
      "readonly": true, 
      "required": false, 
      "title": "Default rule ID associated with the connectivity_strategy", 
      "type": "integer"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "internal_sequence_number": {
      "description": "This field is to indicate the internal sequence number of a policy with respect to the policies across categories.", 
      "readonly": true, 
      "title": "Internal sequence number", 
      "type": "int"
    }, 
    "is_default": {
      "description": "A flag to indicate whether policy is a default policy.", 
      "readonly": true, 
      "required": false, 
      "title": "Default policy flag", 
      "type": "boolean"
    }, 
    "lock_modified_by": {
      "description": "ID of the user who last modified the lock for the secruity policy.", 
      "readonly": true, 
      "required": false, 
      "title": "User who locked the security policy", 
      "type": "string"
    }, 
    "lock_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "description": "SecurityPolicy locked/unlocked time in epoch milliseconds.", 
      "readonly": true, 
      "required": false, 
      "title": "SecuirtyPolicy locked/unlocked time"
    }, 
    "locked": {
      "default": false, 
      "description": "Indicates whether a security policy should be locked. If the security policy is locked by a user, then no other user would be able to modify this security policy. Once the user releases the lock, other users can update this security policy.", 
      "required": false, 
      "title": "Lock a security policy", 
      "type": "boolean"
    }, 
    "logging_enabled": {
      "default": false, 
      "description": "Flag to enable logging for all the rules in the security policy. If the value is true then logging will be enabled for all the rules in the security policy. If the value is false, then the rule level logging value will be honored.", 
      "readonly": false, 
      "required": false, 
      "title": "Enable logging flag", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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"
    }, 
    "rule_count": {
      "description": "The count of rules in the policy.", 
      "readonly": true, 
      "title": "Rule count", 
      "type": "int"
    }, 
    "rules": {
      "items": {
        "$ref": "Rule
      }, 
      "required": false, 
      "title": "Rules that are a part of this SecurityPolicy", 
      "type": "array"
    }, 
    "scheduler_path": {
      "description": "Provides a mechanism to apply the rules in this policy for a specified time duration.", 
      "readonly": false, 
      "required": false, 
      "title": "Path to the scheduler for time based scheduling", 
      "type": "string"
    }, 
    "scope": {
      "description": "The list of group paths where the rules in this policy will get applied. This scope will take precedence over rule level scope. Supported only for security and redirection policies. In case of RedirectionPolicy, it is expected only when the policy is NS and redirecting to service chain.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 128, 
      "required": false, 
      "type": "array"
    }, 
    "sequence_number": {
      "description": "This field is used to resolve conflicts between security policies across domains. In order to change the sequence number of a policy one can fire a POST request on the policy entity with a query parameter action=revise The sequence number field will reflect the value of the computed sequence number upon execution of the above mentioned POST request. For scenarios where the administrator is using a template to update several security policies, the only way to set the sequence number is to explicitly specify the sequence number for each security policy. If no sequence number is specified in the payload, a value of 0 is assigned by default. If there are multiple policies with the same sequence number then their order is not deterministic. If a specific order of policies is desired, then one has to specify unique sequence numbers or use the POST request on the policy entity with a query parameter action=revise to let the framework assign a sequence number", 
      "minimum": 0, 
      "title": "Sequence number to resolve conflicts across Domains", 
      "type": "int"
    }, 
    "stateful": {
      "description": "Stateful or Stateless nature of security policy is enforced on all rules in this security policy. When it is stateful, the state of the network connects are tracked and a stateful packet inspection is performed. Layer3 security policies can be stateful or stateless. By default, they are stateful. Layer2 security policies can only be stateless.", 
      "readonly": false, 
      "required": false, 
      "title": "Stateful nature of the entries within this security policy.", 
      "type": "boolean"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "tcp_strict": {
      "description": "Ensures that a 3 way TCP handshake is done before the data packets are sent. tcp_strict=true is supported only for stateful security policies. If the tcp_strict flag is not specified and the security policy is stateful, then tcp_strict will be set to true.", 
      "readonly": false, 
      "required": false, 
      "title": "Enforce strict tcp handshake before allowing data packets", 
      "type": "boolean"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Contains ordered list of Rules", 
  "type": "object"
}

SecurityPolicyInsertParameters (type)

{
  "description": "Parameters to let the admin specify a relative position of a security policy w.r.t to another one.", 
  "extends": {
    "$ref": "PolicyInsertParameters
  }, 
  "id": "SecurityPolicyInsertParameters", 
  "module_id": "Policy", 
  "properties": {
    "anchor_path": {
      "required": false, 
      "title": "The security policy/rule path if operation is 'insert_after' or\n'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 security policy needs to be placed", 
  "type": "object"
}

SecurityPolicyListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "SecurityPolicyListRequestParameters", 
  "module_id": "Policy", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "include_rule_count": {
      "default": false, 
      "description": "If true, populate the rule_count field with the count of rules in the particular policy. By default, rule_count will not be populated.", 
      "required": false, 
      "title": "Include the count of rules in policy", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "SecurityPolicy list request parameters", 
  "type": "object"
}

SecurityPolicyListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyListResult
  }, 
  "id": "SecurityPolicyListResult", 
  "module_id": "Policy", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "SecurityPolicy
      }, 
      "required": true, 
      "title": "SecurityPolicy list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of security policies", 
  "type": "object"
}

SecurityPolicyStatistics (type)

{
  "description": "Aggregate statistics of all the rules in a security policy.", 
  "id": "SecurityPolicyStatistics", 
  "module_id": "Policy", 
  "properties": {
    "internal_section_id": {
      "description": "Realized id of the section on NSX MP. Policy Manager can create more than one section per SecurityPolicy, in which case this identifier helps to distinguish between the multiple sections created.", 
      "readonly": true, 
      "required": false, 
      "title": "NSX internal section id", 
      "type": "string"
    }, 
    "lr_path": {
      "description": "Path of the LR on which the section is applied in case of Gateway Firewall.", 
      "readonly": true, 
      "required": false, 
      "title": "Logical Router (Tier-0/Tier1) path", 
      "type": "string"
    }, 
    "result_count": {
      "description": "Total count for rule statistics", 
      "readonly": true, 
      "required": true, 
      "title": "Rule stats count", 
      "type": "integer"
    }, 
    "results": {
      "description": "List of rule statistics.", 
      "items": {
        "$ref": "RuleStatistics
      }, 
      "maxItems": 1000, 
      "readonly": true, 
      "required": false, 
      "title": "Statistics for all rules", 
      "type": "array"
    }
  }, 
  "title": "Security policy statistics", 
  "type": "object"
}

SecurityPolicyStatisticsForEnforcementPoint (type)

{
  "description": "Aggregate statistics of all the rules in a security policy for a specific enforcement point.", 
  "id": "SecurityPolicyStatisticsForEnforcementPoint", 
  "module_id": "Policy", 
  "properties": {
    "enforcement_point": {
      "description": "Enforcement point to fetch the statistics from.", 
      "readonly": true, 
      "required": false, 
      "title": "Enforcement point path", 
      "type": "string"
    }, 
    "statistics": {
      "$ref": "SecurityPolicyStatistics, 
      "description": "Statistics for the specified enforcement point", 
      "readonly": true, 
      "required": false, 
      "title": "Security Policy Statistics"
    }
  }, 
  "title": "Security policy statistics for an enforcement point", 
  "type": "object"
}

SecurityPolicyStatisticsListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "SecurityPolicyStatisticsListResult", 
  "module_id": "Policy", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "SecurityPolicyStatisticsForEnforcementPoint
      }, 
      "required": true, 
      "title": "Security Policy statistics list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of Security Policy statistics", 
  "type": "object"
}

SecurityProfileBindingMap (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "SecurityProfileBindingMap", 
  "module_id": "PolicySecurityProfileBinding", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Base security profile binding map", 
  "type": "object"
}

Segment (type)

{
  "additionalProperties": false, 
  "description": "Segment configuration to attach workloads.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "Segment", 
  "module_id": "PolicyConnectivity", 
  "policy_hierarchical_children": [
    "ChildDhcpStaticBindingConfig", 
    "ChildSegmentDiscoveryProfileBindingMap", 
    "ChildSegmentMonitoringProfileBindingMap", 
    "ChildSegmentPort", 
    "ChildSegmentQoSProfileBindingMap", 
    "ChildSegmentSecurityProfileBindingMap", 
    "ChildStaticARPConfig"
  ], 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "address_bindings": {
      "deprecated": true, 
      "description": "Static address binding used for the Segment. This field is deprecated and will be removed in a future release. Please use address_bindings in SegmentPort to configure static bindings.", 
      "items": {
        "$ref": "PortAddressBindingEntry
      }, 
      "maxItems": 512, 
      "required": false, 
      "title": "Address bindings for the Segment", 
      "type": "array"
    }, 
    "admin_state": {
      "default": "UP", 
      "enum": [
        "UP", 
        "DOWN"
      ], 
      "required": false, 
      "title": "Represents Desired state of the Segment", 
      "type": "string"
    }, 
    "advanced_config": {
      "$ref": "SegmentAdvancedConfig, 
      "description": "Advanced configuration for Segment.", 
      "required": false, 
      "title": "Advanced configuration for Segment"
    }, 
    "bridge_profiles": {
      "description": "Multiple distinct L2 bridge profiles can be configured.", 
      "items": {
        "$ref": "BridgeProfileConfig
      }, 
      "title": "Bridge Profile Configuration", 
      "type": "array"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "connectivity_path": {
      "description": "Policy path to the connecting Tier-0 or Tier-1. Valid only for segments created under Infra.", 
      "required": false, 
      "title": "Policy path to the connecting Tier-0 or Tier-1", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "dhcp_config_path": {
      "description": "Policy path to DHCP server or relay configuration to use for all IPv4 & IPv6 subnets configured on this segment.", 
      "required": false, 
      "title": "Policy path to DHCP configuration", 
      "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"
    }, 
    "domain_name": {
      "required": false, 
      "title": "DNS domain name", 
      "type": "string"
    }, 
    "evpn_segment": {
      "description": "Flag to indicate if the Segment is a Child-Segment of type EVPN.", 
      "readonly": true, 
      "title": "Evpn Segment Flag.", 
      "type": "boolean"
    }, 
    "evpn_tenant_config_path": {
      "description": "Policy path to the EvpnTenantConfig resource. Supported only for Route-Server Evpn Mode. Supported only for Overlay Segments. This will be populated for both Parent and Child segments participating in Evpn Route-Server Mode.", 
      "required": false, 
      "title": "Policy path to the EvpnTenantConfig", 
      "type": "string"
    }, 
    "extra_configs": {
      "description": "This property could be used for vendor specific configuration in key value string pairs, the setting in extra_configs will be automatically inheritted by segment ports in the Segment.", 
      "items": {
        "$ref": "SegmentExtraConfig
      }, 
      "required": false, 
      "title": "Extra configs on Segment", 
      "type": "array"
    }, 
    "federation_config": {
      "$ref": "FederationConnectivityConfig, 
      "description": "Additional config for federation.", 
      "readonly": true, 
      "title": "Federation releated config"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "l2_extension": {
      "$ref": "L2Extension, 
      "required": false, 
      "title": "Configuration for extending Segment through L2 VPN"
    }, 
    "ls_id": {
      "deprecated": true, 
      "description": "This property is deprecated. The property will continue to work as expected for existing segments. The segments that are newly created with ls_id will be ignored. Sepcify pre-creted logical switch id for Segment.", 
      "required": false, 
      "title": "Pre-created logical switch id for Segment", 
      "type": "string"
    }, 
    "mac_pool_id": {
      "description": "Mac pool id that associated with a Segment.", 
      "required": false, 
      "title": "Allocation mac pool associated with the Segment", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "metadata_proxy_paths": {
      "description": "Policy path to metadata proxy configuration. Multiple distinct MD proxies can be configured.", 
      "items": {
        "type": "string"
      }, 
      "title": "Metadata Proxy Configuration Paths", 
      "type": "array"
    }, 
    "overlay_id": {
      "description": "Used for overlay connectivity of segments. The overlay_id should be allocated from the pool as definied by enforcement-point. If not provided, it is auto-allocated from the default pool on the enforcement-point.", 
      "maximum": 2147483647, 
      "minimum": 0, 
      "required": false, 
      "title": "Overlay connectivity ID for this Segment", 
      "type": "int"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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"
    }, 
    "replication_mode": {
      "default": "MTEP", 
      "description": "If this field is not set for overlay segment, then the default of MTEP will be used.", 
      "enum": [
        "MTEP", 
        "SOURCE"
      ], 
      "required": false, 
      "title": "Replication mode of the Segment", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "subnets": {
      "items": {
        "$ref": "SegmentSubnet
      }, 
      "required": false, 
      "title": "Subnet configuration. Max 1 subnet", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "transport_zone_path": {
      "description": "Policy path to the transport zone. Supported for VLAN backed segments as well as Overlay Segments. - This field is required for VLAN backed Segments. - For overlay Segments, it is auto assigned if only one transport zone   exists in the enforcement point. Default transport zone is auto   assigned for  overlay segments if none specified.", 
      "required": false, 
      "title": "Policy path to the transport zone", 
      "type": "string"
    }, 
    "type": {
      "description": "Segment type based on configuration.", 
      "enum": [
        "ROUTED", 
        "EXTENDED", 
        "ROUTED_AND_EXTENDED", 
        "DISCONNECTED"
      ], 
      "readonly": true, 
      "title": "Segment type", 
      "type": "string"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }, 
    "vlan_ids": {
      "description": "VLAN ids for a VLAN backed Segment. Can be a VLAN id or a range of VLAN ids specified with '-' in between.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "VLAN ids for VLAN backed Segment", 
      "type": "array"
    }
  }, 
  "title": "Segment configuration", 
  "type": "object"
}

SegmentAdvancedConfig (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ConnectivityAdvancedConfig
  }, 
  "id": "SegmentAdvancedConfig", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "address_pool_paths": {
      "description": "Policy path to IP address pools.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 1, 
      "required": false, 
      "title": "Policy path to IP address pools", 
      "type": "array"
    }, 
    "connectivity": {
      "default": "ON", 
      "description": "Connectivity configuration to manually connect (ON) or disconnect (OFF) a Tier1 segment from corresponding Tier1 gateway. Only valid for Tier1 Segments. This property is ignored for L2 VPN extended segments when subnets property is not specified.", 
      "enum": [
        "ON", 
        "OFF"
      ], 
      "required": false, 
      "title": "Connectivity configuration", 
      "type": "string"
    }, 
    "hybrid": {
      "default": false, 
      "description": "When set to true, all the ports created on this segment will behave in a hybrid fashion. The hybrid port indicates to NSX that the VM intends to operate in underlay mode, but retains the ability to forward egress traffic to the NSX overlay network. This property is only applicable for segment created with transport zone type OVERLAY_STANDARD. This property cannot be modified after segment is created.", 
      "required": false, 
      "title": "Flag to identify a hybrid logical switch", 
      "type": "boolean"
    }, 
    "inter_router": {
      "default": false, 
      "description": "When set to true, any port attached to this logical switch will not be visible through VC/ESX UI", 
      "required": false, 
      "title": "Flag to indicate if the logical switch will provide inter-router connectivity", 
      "type": "boolean"
    }, 
    "local_egress": {
      "default": false, 
      "description": "This property is used to enable proximity routing with local egress. When set to true, logical router interface (downlink) connecting Segment to Tier0/Tier1 gateway is configured with prefix-length 32.", 
      "required": false, 
      "title": "Flag to enable local egress", 
      "type": "boolean"
    }, 
    "local_egress_routing_policies": {
      "description": "An ordered list of routing policies to forward traffic to the next hop.", 
      "items": {
        "$ref": "LocalEgressRoutingEntry
      }, 
      "minItems": 1, 
      "required": false, 
      "title": "Local egress routing policies", 
      "type": "array"
    }, 
    "multicast": {
      "description": "Enable multicast on the downlink LRP created to connect the segment to Tier0/Tier1 gateway.  Enabled by default, even when segment.advanced_config property is not specified.", 
      "required": false, 
      "title": "Enable multicast on the downlink", 
      "type": "boolean"
    }, 
    "ndra_profile_path": {
      "description": "This profile is applie dto the downlink logical router port created while attaching this semgnet to tier-0 or tier-1. If this field is empty, NDRA profile of the router is applied to the newly created port.", 
      "required": false, 
      "title": "Policy path of Neighbor Discovery Router Advertisement profile", 
      "type": "string"
    }, 
    "uplink_teaming_policy_name": {
      "description": "The name of the switching uplink teaming policy for the Segment. This name corresponds to one of the switching uplink teaming policy names listed in TransportZone associated with the Segment. See transport_zone_path property above for more details. When this property is not specified, the segment will not have a teaming policy associated with it and the host switch's default teaming policy will be used by MP.", 
      "title": "Uplink Teaming Policy Name", 
      "type": "string"
    }, 
    "urpf_mode": {
      "default": "STRICT", 
      "description": "This URPF mode is applied to the downlink logical router port created while attaching this segment to tier-0 or tier-1.", 
      "enum": [
        "NONE", 
        "STRICT"
      ], 
      "required": false, 
      "title": "Unicast Reverse Path Forwarding mode", 
      "type": "string"
    }
  }, 
  "title": "Advanced configuration for Segment", 
  "type": "object"
}

SegmentConfigurationState (type)

{
  "additionalProperties": false, 
  "description": "Segment state on specific Enforcement Point.", 
  "extends": {
    "$ref": "ConfigurationState
  }, 
  "id": "SegmentConfigurationState", 
  "module_id": "PolicyConnectivityStatistics", 
  "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"
    }, 
    "segment_path": {
      "readonly": true, 
      "required": false, 
      "title": "Segment path", 
      "type": "string"
    }, 
    "state": {
      "description": "Gives details of state of desired configuration. Additional enums with more details on progress/success/error states are sent for edge node. The success states are NODE_READY and TRANSPORT_NODE_READY, pending states are {VM_DEPLOYMENT_QUEUED, VM_DEPLOYMENT_IN_PROGRESS, REGISTRATION_PENDING} and other values indicate failures. \"in_sync\" state indicates that the desired configuration has been received by the host to which it applies, but is not yet in effect. When the configuration is actually in effect, the state will change to \"success\". Please note, failed state is deprecated.", 
      "enum": [
        "pending", 
        "in_progress", 
        "success", 
        "failed", 
        "partial_success", 
        "orphaned", 
        "unknown", 
        "error", 
        "in_sync", 
        "NOT_AVAILABLE", 
        "VM_DEPLOYMENT_QUEUED", 
        "VM_DEPLOYMENT_IN_PROGRESS", 
        "VM_DEPLOYMENT_FAILED", 
        "VM_POWER_ON_IN_PROGRESS", 
        "VM_POWER_ON_FAILED", 
        "REGISTRATION_PENDING", 
        "NODE_NOT_READY", 
        "NODE_READY", 
        "VM_POWER_OFF_IN_PROGRESS", 
        "VM_POWER_OFF_FAILED", 
        "VM_UNDEPLOY_IN_PROGRESS", 
        "VM_UNDEPLOY_FAILED", 
        "VM_UNDEPLOY_SUCCESSFUL", 
        "EDGE_CONFIG_ERROR", 
        "VM_DEPLOYMENT_RESTARTED", 
        "REGISTRATION_FAILED", 
        "TRANSPORT_NODE_SYNC_PENDING", 
        "TRANSPORT_NODE_CONFIGURATION_MISSING", 
        "EDGE_HARDWARE_NOT_SUPPORTED", 
        "MULTIPLE_OVERLAY_TZS_NOT_SUPPORTED", 
        "TN_OVERLAY_TZ_IN_USE_BY_EDGE_CLUSTER", 
        "TZ_ENDPOINTS_NOT_SPECIFIED", 
        "NO_PNIC_PREPARED_IN_EDGE", 
        "APPLIANCE_INTERNAL_ERROR", 
        "VTEP_DHCP_NOT_SUPPORTED", 
        "UNSUPPORTED_HOST_SWITCH_PROFILE", 
        "UPLINK_HOST_SWITCH_PROFILE_NOT_SPECIFIED", 
        "HOSTSWITCH_PROFILE_NOT_FOUND", 
        "LLDP_SEND_ENABLED_NOT_SUPPORTED", 
        "UNSUPPORTED_NAMED_TEAMING_POLICY", 
        "LBSRCID_NOT_SUPPORTED_FOR_EDGE_VM", 
        "LACP_NOT_SUPPORTED_FOR_EDGE_VM", 
        "STANDBY_UPLINKS_NOT_SUPPORTED_FOR_EDGE_VM", 
        "MULTIPLE_ACTIVE_UPLINKS_NOT_SUPPORTED_FOR_EDGE", 
        "UNSUPPORTED_LACP_LB_ALGO_FOR_NODE", 
        "EDGE_NODE_VERSION_NOT_SUPPORTED", 
        "NO_PNIC_SPECIFIED_IN_TN", 
        "INVALID_PNIC_DEVICE_NAME", 
        "TRANSPORT_NODE_READY", 
        "VM_NETWORK_EDIT_PENDING", 
        "UNSUPPORTED_DEFAULT_TEAMING_POLICY", 
        "MPA_DISCONNECTED", 
        "VM_RENAME_PENDING", 
        "VM_CONFIG_EDIT_PENDING", 
        "VM_NETWORK_EDIT_FAILED", 
        "VM_RENAME_FAILED", 
        "VM_CONFIG_EDIT_FAILED", 
        "VM_CONFIG_DISCREPANCY", 
        "VM_NODE_REFRESH_FAILED", 
        "VM_PLACEMENT_REFRESH_FAILED", 
        "REGISTRATION_TIMEDOUT", 
        "REPLACE_FAILED", 
        "UPLINK_FROM_TEAMING_POLICY_NOT_MAPPED", 
        "LOGICAL_SWITCH_NAMED_TEAMING_HAS_NO_PNIC_BACKING", 
        "DELETE_VM_IN_REDEPLOY_FAILED", 
        "DEPLOY_VM_IN_REDEPLOY_FAILED", 
        "INSUFFICIENT_RESOURCES_IN_EDGE_NODE_FOR_SERVICE"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Overall state of desired configuration", 
      "type": "string"
    }
  }, 
  "title": "Segment state on specific Enforcement Point", 
  "type": "object"
}

SegmentConfigurationStateListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "SegmentConfigurationStateListResult", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Paged Collection of Segment State on specific Enforcement Point", 
      "items": {
        "$ref": "SegmentConfigurationState
      }, 
      "required": false, 
      "title": "Paged Collection of Segment State on specific Enforcement Point", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

SegmentCrossSiteTrafficStats (type)

{
  "additionalProperties": false, 
  "id": "SegmentCrossSiteTrafficStats", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "last_update_timestamp": {
      "$ref": "EpochMsTimestamp, 
      "description": "Timestamp when the l2 forwarder statistics was last updated.", 
      "readonly": true, 
      "required": true, 
      "title": "Last updated timestamp"
    }, 
    "rx_stats": {
      "$ref": "InterSitePortCounters, 
      "description": "Total received data counters.", 
      "readonly": true, 
      "title": "Received data counters"
    }, 
    "segment_path": {
      "description": "Policy path of Segment to attach interface.", 
      "readonly": true, 
      "required": true, 
      "title": "Policy path of Segment to attach interface", 
      "type": "string"
    }, 
    "tx_stats": {
      "$ref": "InterSitePortCounters, 
      "description": "Total sent data counters.", 
      "readonly": true, 
      "title": "Sent data counters"
    }
  }, 
  "type": "object"
}

SegmentDhcpConfig (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "description": "DHCP IPv4 and IPv6 configurations are extended from this abstract class.", 
  "id": "SegmentDhcpConfig", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "resource_type"
  }, 
  "properties": {
    "dns_servers": {
      "description": "IP address of DNS servers for subnet. DNS server IP address must belong to the same address family as segment gateway_address property.", 
      "items": {
        "$ref": "IPAddress
      }, 
      "maxItems": 2, 
      "required": false, 
      "title": "DNS servers for subnet", 
      "type": "array"
    }, 
    "lease_time": {
      "default": 86400, 
      "description": "DHCP lease time in seconds. When specified, this property overwrites lease time configured DHCP server config.", 
      "maximum": 4294967295, 
      "minimum": 60, 
      "required": false, 
      "title": "DHCP lease time for subnet", 
      "type": "integer"
    }, 
    "resource_type": {
      "enum": [
        "SegmentDhcpV4Config", 
        "SegmentDhcpV6Config"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "server_address": {
      "$ref": "IPCIDRBlock, 
      "description": "IP address of the DHCP server in CIDR format. The server_address is mandatory in case this segment has provided a dhcp_config_path and it represents a DHCP server config. If this SegmentDhcpConfig is a SegmentDhcpV4Config, the address must be an IPv4 address. If this is a SegmentDhcpV6Config, the address must be an IPv6 address. This address must not overlap the ip-ranges of the subnet, or the gateway address of the subnet, or the DHCP static-binding addresses of this segment.", 
      "required": false, 
      "title": "IP address of the DHCP server"
    }
  }, 
  "title": "DHCP configuration for segment subnet", 
  "type": "object"
}

SegmentDhcpV4Config (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "SegmentDhcpConfig
  }, 
  "id": "SegmentDhcpV4Config", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "SegmentDhcpV4Config"
  }, 
  "properties": {
    "dns_servers": {
      "description": "IP address of DNS servers for subnet. DNS server IP address must belong to the same address family as segment gateway_address property.", 
      "items": {
        "$ref": "IPAddress
      }, 
      "maxItems": 2, 
      "required": false, 
      "title": "DNS servers for subnet", 
      "type": "array"
    }, 
    "lease_time": {
      "default": 86400, 
      "description": "DHCP lease time in seconds. When specified, this property overwrites lease time configured DHCP server config.", 
      "maximum": 4294967295, 
      "minimum": 60, 
      "required": false, 
      "title": "DHCP lease time for subnet", 
      "type": "integer"
    }, 
    "options": {
      "$ref": "DhcpV4Options, 
      "description": "IPv4 DHCP options for segment subnet.", 
      "required": false, 
      "title": "DHCP options"
    }, 
    "resource_type": {
      "enum": [
        "SegmentDhcpV4Config", 
        "SegmentDhcpV6Config"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "server_address": {
      "$ref": "IPCIDRBlock, 
      "description": "IP address of the DHCP server in CIDR format. The server_address is mandatory in case this segment has provided a dhcp_config_path and it represents a DHCP server config. If this SegmentDhcpConfig is a SegmentDhcpV4Config, the address must be an IPv4 address. If this is a SegmentDhcpV6Config, the address must be an IPv6 address. This address must not overlap the ip-ranges of the subnet, or the gateway address of the subnet, or the DHCP static-binding addresses of this segment.", 
      "required": false, 
      "title": "IP address of the DHCP server"
    }
  }, 
  "title": "DHCP configuration of IPv4 subnet in a segment", 
  "type": "object"
}

SegmentDhcpV6Config (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "SegmentDhcpConfig
  }, 
  "id": "SegmentDhcpV6Config", 
  "module_id": "PolicyConnectivity", 
  "polymorphic-type-descriptor": {
    "type-identifier": "SegmentDhcpV6Config"
  }, 
  "properties": {
    "dns_servers": {
      "description": "IP address of DNS servers for subnet. DNS server IP address must belong to the same address family as segment gateway_address property.", 
      "items": {
        "$ref": "IPAddress
      }, 
      "maxItems": 2, 
      "required": false, 
      "title": "DNS servers for subnet", 
      "type": "array"
    }, 
    "domain_names": {
      "description": "Domain names for subnet.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Domain names for subnet", 
      "type": "array"
    }, 
    "excluded_ranges": {
      "description": "Excluded addresses to define dynamic ip allocation ranges.", 
      "items": {
        "$ref": "IPElement
      }, 
      "maxItems": 128, 
      "minItems": 0, 
      "required": false, 
      "title": "Excluded range of IPv6 addresses", 
      "type": "array"
    }, 
    "lease_time": {
      "default": 86400, 
      "description": "DHCP lease time in seconds. When specified, this property overwrites lease time configured DHCP server config.", 
      "maximum": 4294967295, 
      "minimum": 60, 
      "required": false, 
      "title": "DHCP lease time for subnet", 
      "type": "integer"
    }, 
    "preferred_time": {
      "description": "The length of time that a valid address is preferred. When the preferred lifetime expires, the address becomes deprecated.", 
      "maximum": 4294967295, 
      "minimum": 60, 
      "required": false, 
      "title": "Preferred time", 
      "type": "integer"
    }, 
    "resource_type": {
      "enum": [
        "SegmentDhcpV4Config", 
        "SegmentDhcpV6Config"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "server_address": {
      "$ref": "IPCIDRBlock, 
      "description": "IP address of the DHCP server in CIDR format. The server_address is mandatory in case this segment has provided a dhcp_config_path and it represents a DHCP server config. If this SegmentDhcpConfig is a SegmentDhcpV4Config, the address must be an IPv4 address. If this is a SegmentDhcpV6Config, the address must be an IPv6 address. This address must not overlap the ip-ranges of the subnet, or the gateway address of the subnet, or the DHCP static-binding addresses of this segment.", 
      "required": false, 
      "title": "IP address of the DHCP server"
    }, 
    "sntp_servers": {
      "description": "IPv6 address of SNTP servers for subnet.", 
      "items": {
        "$ref": "IPv6Address
      }, 
      "maxItems": 2, 
      "required": false, 
      "title": "SNTP servers for subnet", 
      "type": "array"
    }
  }, 
  "title": "DHCP configuration of IPv6 subnet in a segment", 
  "type": "object"
}

SegmentDiscoveryProfileBindingMap (type)

{
  "additionalProperties": false, 
  "description": "This entity will be used to establish association between discovery profile and Segment. Using this entity, user can specify intent for applying discovery profile to particular segments.", 
  "extends": {
    "$ref": "DiscoveryProfileBindingMap
  }, 
  "id": "SegmentDiscoveryProfileBindingMap", 
  "module_id": "PolicyDiscoveryProfileBinding", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ip_discovery_profile_path": {
      "description": "PolicyPath of associated IP Discovery Profile", 
      "required": false, 
      "title": "IP Discovery Profile Path", 
      "type": "string"
    }, 
    "mac_discovery_profile_path": {
      "description": "PolicyPath of associated Mac Discovery Profile", 
      "required": false, 
      "title": "Mac Discovery Profile Path", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Segment Discovery Profile binding map", 
  "type": "object"
}

SegmentDiscoveryProfileBindingMapListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "SegmentDiscoveryProfileBindingMapListRequestParameters", 
  "module_id": "PolicyDiscoveryProfileBinding", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Segment Discovery Profile Binding Map list request parameters", 
  "type": "object"
}

SegmentDiscoveryProfileBindingMapListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "SegmentDiscoveryProfileBindingMapListResult", 
  "module_id": "PolicyDiscoveryProfileBinding", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "SegmentDiscoveryProfileBindingMap
      }, 
      "required": true, 
      "title": "Segment Discovery Profile Binding Map list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged collection of Segment Discovery Profile Binding Maps", 
  "type": "object"
}

SegmentExtraConfig (type)

{
  "additionalProperties": false, 
  "description": "Segment extra config is intended for supporting vendor specific configuration on the data path, it can be set as key value string pairs on either segment or segment port.", 
  "id": "SegmentExtraConfig", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "config_pair": {
      "$ref": "UnboundedKeyValuePair, 
      "required": true, 
      "title": "Key value pair in string for the configuration"
    }
  }, 
  "title": "Vendor specific configuration on segment or Segment port", 
  "type": "object"
}

SegmentL2ForwarderSiteSpanInfo (type)

{
  "additionalProperties": false, 
  "experimental": true, 
  "id": "SegmentL2ForwarderSiteSpanInfo", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "inter_site_forwarder_status": {
      "description": "Inter-site forwarder status per node.", 
      "items": {
        "$ref": "L2ForwarderStatusPerNode
      }, 
      "readonly": true, 
      "title": "Inter-site forwarder status per node", 
      "type": "array"
    }, 
    "last_update_timestamp": {
      "$ref": "EpochMsTimestamp, 
      "description": "Timestamp when the L2 forwarder remote mac addresses was last updated.", 
      "readonly": true, 
      "required": true, 
      "title": "Last updated timestamp"
    }, 
    "remote_macs_per_site": {
      "description": "L2 forwarder remote mac addresses per site for logical switch.", 
      "items": {
        "$ref": "L2ForwarderRemoteMacsPerSite
      }, 
      "readonly": true, 
      "title": "L2 forwarder remote mac addresses per site", 
      "type": "array"
    }, 
    "segment_path": {
      "description": "Policy path of a segment.", 
      "readonly": true, 
      "required": true, 
      "title": "Segment path", 
      "type": "string"
    }
  }, 
  "type": "object"
}

SegmentListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "SegmentListRequestParameters", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Segment list request parameters", 
  "type": "object"
}

SegmentListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "SegmentListResult", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "Segment
      }, 
      "required": true, 
      "title": "Segment list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged collection of Segments", 
  "type": "object"
}

SegmentMacAddressListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "SegmentMacAddressListResult", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "last_update_timestamp": {
      "$ref": "EpochMsTimestamp, 
      "description": "Timestamp when the data was last updated; unset if data source has never updated the data.", 
      "readonly": true
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "MacTableEntry
      }, 
      "required": false, 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "transport_node_id": {
      "readonly": true, 
      "required": false, 
      "title": "Transport node identifier", 
      "type": "string"
    }
  }, 
  "type": "object"
}

SegmentMonitoringProfileBindingMap (type)

{
  "additionalProperties": false, 
  "description": "This entity will be used to establish association between monitoring profile and Segment. Using this entity, you can specify intent for applying monitoring profile to particular segment.", 
  "extends": {
    "$ref": "MonitoringProfileBindingMap
  }, 
  "id": "SegmentMonitoringProfileBindingMap", 
  "module_id": "PolicyMonitoringProfileBinding", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ipfix_l2_profile_path": {
      "description": "PolicyPath of associated IPFIX L2 Profile", 
      "required": false, 
      "title": "IPFIX L2 Profile Path", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "port_mirroring_profile_path": {
      "description": "PolicyPath of associated Port Mirroring Profile", 
      "required": false, 
      "title": "Port Mirroring Profile Path", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Segment Monitoring Profile binding map", 
  "type": "object"
}

SegmentMonitoringProfileBindingMapListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "SegmentMonitoringProfileBindingMapListRequestParameters", 
  "module_id": "PolicyMonitoringProfileBinding", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Segment Monitoring Profile Binding Map list request parameters", 
  "type": "object"
}

SegmentMonitoringProfileBindingMapListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "SegmentMonitoringProfileBindingMapListResult", 
  "module_id": "PolicyMonitoringProfileBinding", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "SegmentMonitoringProfileBindingMap
      }, 
      "required": true, 
      "title": "Segment Monitoring Profile Binding Map list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged collection of Segment Monitoring Profile Binding Maps", 
  "type": "object"
}

SegmentPort (type)

{
  "additionalProperties": false, 
  "description": "Policy port will create LogicalPort on LogicalSwitch corresponding to the Segment. Address bindings cannot be removed after realization.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "SegmentPort", 
  "module_id": "PolicyConnectivity", 
  "policy_hierarchical_children": [
    "ChildPortDiscoveryProfileBindingMap", 
    "ChildPortMonitoringProfileBindingMap", 
    "ChildPortQoSProfileBindingMap", 
    "ChildPortSecurityProfileBindingMap"
  ], 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "address_bindings": {
      "description": "Static address binding used for the port.", 
      "items": {
        "$ref": "PortAddressBindingEntry
      }, 
      "maxItems": 512, 
      "required": false, 
      "title": "Address bindings for the port", 
      "type": "array"
    }, 
    "admin_state": {
      "default": "UP", 
      "enum": [
        "UP", 
        "DOWN"
      ], 
      "required": false, 
      "title": "Represents desired state of the segment port", 
      "type": "string"
    }, 
    "attachment": {
      "$ref": "PortAttachment, 
      "description": "Only VIF attachment is supported", 
      "required": false, 
      "title": "VIF attachment"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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"
    }, 
    "extra_configs": {
      "description": "This property could be used for vendor specific configuration in key value string pairs. Segment port setting will override segment setting if the same key was set on both segment and segment port.", 
      "items": {
        "$ref": "SegmentExtraConfig
      }, 
      "required": false, 
      "title": "Extra configs on segment port", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ignored_address_bindings": {
      "description": "IP Discovery module uses various mechanisms to discover address bindings being used on each segment port. If a user would like to ignore any specific discovered address bindings or prevent the discovery of a particular set of discovered bindings, then those address bindings can be provided here. Currently IP range in CIDR format is not supported.", 
      "items": {
        "$ref": "PortAddressBindingEntry
      }, 
      "maxItems": 16, 
      "minItems": 0, 
      "required": false, 
      "title": "Address bindings to be ignored by IP Discovery module", 
      "type": "array"
    }, 
    "init_state": {
      "description": "Set initial state when a new logical port is created. 'UNBLOCKED_VLAN' means new port will be unblocked on traffic in creation, also VLAN will be set with corresponding logical switch setting. This port setting can only be configured at port creation, and cannot be modified. 'RESTORE_VIF' fetches and restores VIF attachment from ESX host.", 
      "enum": [
        "UNBLOCKED_VLAN", 
        "RESTORE_VIF"
      ], 
      "required": false, 
      "title": "Initial state of this logical ports", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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"
    }, 
    "source_site_id": {
      "description": "This field will refer to the source site on which the segment port is discovered. This field is populated by GM, when it receives corresponding notification from LM.", 
      "readonly": true, 
      "title": "source site(LM) id.", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Policy port object for segment", 
  "type": "object"
}

SegmentPortAttachmentState (type)

{
  "additionalProperties": false, 
  "id": "SegmentPortAttachmentState", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "attachers": {
      "items": {
        "$ref": "PortAttacher
      }, 
      "readonly": true, 
      "required": false, 
      "title": "VM or vmknic entities that are attached to the Segment Port", 
      "type": "array"
    }, 
    "id": {
      "readonly": true, 
      "required": false, 
      "title": "VIF ID", 
      "type": "string"
    }, 
    "state": {
      "description": "A segment port must be in one of following states. FREE - If there are no active attachers. The port may or may not have an attachment ID configured on it. This state is applicable only to port of static type. ATTACHED - Segment port has exactly one active attacher and no further configuration is pending. ATTACHED_PENDING_CONF - Segment port has exactly one attacher, however it may not have been configured completely. Additional configuration will be provided by other nsx components. ATTACHED_IN_MOTION - Segment port has multiple active attachers. This state represents a scenario where VM is moving from one location (host or storage) to another (e.g. vmotion, vSphere HA) DETACHED - A temporary state after all port attachers have been detached. This state is applicable only to a port of ephemeral type and the port will soon be deleted.", 
      "enum": [
        "FREE", 
        "ATTACHED", 
        "ATTACHED_PENDING_CONF", 
        "ATTACHED_IN_MOTION", 
        "DETACHED"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "State of the VIF attached to Segment Port", 
      "type": "string"
    }
  }, 
  "title": "VIF attachment state of a segment port", 
  "type": "object"
}

SegmentPortListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "SegmentPortListRequestParameters", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "SegmentPort list request parameters", 
  "type": "object"
}

SegmentPortListResult (type)

{
  "additionalProperties": false, 
  "description": "List SegmentPort objects", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "SegmentPortListResult", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Place holder for the list result", 
      "items": {
        "$ref": "SegmentPort
      }, 
      "required": true, 
      "title": "SegmentPort list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged collection of SegmentPort", 
  "type": "object"
}

SegmentPortMacAddressCsvListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "CsvListResult
  }, 
  "id": "SegmentPortMacAddressCsvListResult", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "file_name": {
      "description": "File name set by HTTP server if API  returns CSV result as a file.", 
      "required": false, 
      "title": "File name", 
      "type": "string"
    }, 
    "last_update_timestamp": {
      "$ref": "EpochMsTimestamp, 
      "description": "Timestamp when the data was last updated; unset if data source has never updated the data.", 
      "readonly": true
    }, 
    "results": {
      "items": {
        "$ref": "SegmentPortMacTableCsvEntry
      }, 
      "required": false, 
      "type": "array"
    }
  }, 
  "type": "object"
}

SegmentPortMacAddressListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "SegmentPortMacAddressListResult", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "last_update_timestamp": {
      "$ref": "EpochMsTimestamp, 
      "description": "Timestamp when the data was last updated; unset if data source has never updated the data.", 
      "readonly": true
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "SegmentPortMacTableEntry
      }, 
      "required": false, 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "transport_node_id": {
      "readonly": true, 
      "required": false, 
      "title": "Transport node identifier", 
      "type": "string"
    }
  }, 
  "type": "object"
}

SegmentPortMacTableCsvEntry (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "CsvRecord
  }, 
  "id": "SegmentPortMacTableCsvEntry", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "mac_address": {
      "required": true, 
      "title": "The MAC address", 
      "type": "string"
    }, 
    "mac_type": {
      "$ref": "MacAddressType, 
      "required": true, 
      "title": "The type of the MAC address"
    }
  }, 
  "type": "object"
}

SegmentPortMacTableEntry (type)

{
  "additionalProperties": false, 
  "id": "SegmentPortMacTableEntry", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "mac_address": {
      "required": true, 
      "title": "The MAC address", 
      "type": "string"
    }, 
    "mac_type": {
      "$ref": "MacAddressType, 
      "required": true, 
      "title": "The type of the MAC address"
    }
  }, 
  "type": "object"
}

SegmentPortState (type)

{
  "additionalProperties": false, 
  "description": "Contains realized state of the segment port. For example: transport node on which the port is located, discovered and realized address bindings of the port.", 
  "id": "SegmentPortState", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "attachment": {
      "$ref": "SegmentPortAttachmentState, 
      "readonly": true, 
      "required": false, 
      "title": "Segment port attachment state"
    }, 
    "discovered_bindings": {
      "description": "Contains the list of address bindings for a segment port that were automatically dicovered using various snooping methods like ARP, DHCP etc.", 
      "items": {
        "$ref": "AddressBindingEntry
      }, 
      "title": "Segment port bindings discovered automatically", 
      "type": "array"
    }, 
    "duplicate_bindings": {
      "description": "If any address binding discovered on the port is also found on other port on the same segment, then it is included in the duplicate bindings list along with the ID of the port with which it conflicts.", 
      "items": {
        "$ref": "DuplicateAddressBindingEntry
      }, 
      "title": "Duplicate segment port address bindings", 
      "type": "array"
    }, 
    "realized_bindings": {
      "description": "List of segment port bindings that are realized. This list may be populated from the discovered bindings or manual user specified bindings. This binding configuration can be used by features such as firewall, spoof-guard, traceflow etc.", 
      "items": {
        "$ref": "AddressBindingEntry
      }, 
      "title": "Realized segment port bindings", 
      "type": "array"
    }, 
    "transport_node_ids": {
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Identifiers of the transport nodes where the port is located", 
      "type": "array"
    }
  }, 
  "title": "Realized state of the segment port on enforcement point", 
  "type": "object"
}

SegmentPortStatistics (type)

{
  "additionalProperties": false, 
  "description": "Segment port statistics on specific Enforcement Point.", 
  "extends": {
    "$ref": "LogicalPortStatistics
  }, 
  "id": "SegmentPortStatistics", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "dropped_by_security_packets": {
      "$ref": "PacketsDroppedBySecurity, 
      "readonly": true, 
      "required": false
    }, 
    "last_update_timestamp": {
      "$ref": "EpochMsTimestamp, 
      "description": "Timestamp when the data was last updated; unset if data source has never updated the data.", 
      "readonly": true
    }, 
    "logical_port_id": {
      "readonly": true, 
      "required": true, 
      "title": "The id of the logical port", 
      "type": "string"
    }, 
    "mac_learning": {
      "$ref": "MacLearningCounters, 
      "readonly": true, 
      "required": false
    }, 
    "rx_bytes": {
      "$ref": "DataCounter, 
      "readonly": true, 
      "required": false
    }, 
    "rx_packets": {
      "$ref": "DataCounter, 
      "readonly": true, 
      "required": false
    }, 
    "tx_bytes": {
      "$ref": "DataCounter, 
      "readonly": true, 
      "required": false
    }, 
    "tx_packets": {
      "$ref": "DataCounter, 
      "readonly": true, 
      "required": false
    }
  }, 
  "title": "Segment port statistics on specific Enforcement Point", 
  "type": "object"
}

SegmentQoSProfileBindingMap (type)

{
  "additionalProperties": false, 
  "description": "This entity will be used to establish association between qos profile and Segment. Using this entity, you can specify intent for applying qos profile to particular segment.", 
  "extends": {
    "$ref": "QoSProfileBindingMap
  }, 
  "id": "SegmentQoSProfileBindingMap", 
  "module_id": "PolicyQoSProfileBinding", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "qos_profile_path": {
      "description": "PolicyPath of associated  QoS Profile", 
      "required": false, 
      "title": "QoS Profile Path", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "search_dsl_name": [
    "segment qos profile binding map"
  ], 
  "title": "Segment QoS Profile binding map", 
  "type": "object"
}

SegmentQoSProfileBindingMapListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "SegmentQoSProfileBindingMapListRequestParameters", 
  "module_id": "PolicyQoSProfileBinding", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Segment QoS Profile Binding Map list request parameters", 
  "type": "object"
}

SegmentQoSProfileBindingMapListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "SegmentQoSProfileBindingMapListResult", 
  "module_id": "PolicyQoSProfileBinding", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "SegmentQoSProfileBindingMap
      }, 
      "required": true, 
      "title": "Segment QoS Profile Binding Map list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged collection of Segment QoS Profile Binding Maps", 
  "type": "object"
}

SegmentSecurityProfile (type)

{
  "additionalProperties": false, 
  "description": "Security features extended by policy operations for securing logical segments.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "SegmentSecurityProfile", 
  "module_id": "PolicySegmentSecurity", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "bpdu_filter_allow": {
      "description": "Pre-defined list of allowed MAC addresses to be excluded from BPDU filtering. List of allowed MACs - 01:80:c2:00:00:00, 01:80:c2:00:00:01, 01:80:c2:00:00:02, 01:80:c2:00:00:03,                        01:80:c2:00:00:04, 01:80:c2:00:00:05, 01:80:c2:00:00:06, 01:80:c2:00:00:07,                        01:80:c2:00:00:08, 01:80:c2:00:00:09, 01:80:c2:00:00:0a, 01:80:c2:00:00:0b,                        01:80:c2:00:00:0c, 01:80:c2:00:00:0d, 01:80:c2:00:00:0e, 01:80:c2:00:00:0f,                        00:e0:2b:00:00:00, 00:e0:2b:00:00:04, 00:e0:2b:00:00:06, 01:00:0c:00:00:00,                        01:00:0c:cc:cc:cc, 01:00:0c:cc:cc:cd, 01:00:0c:cd:cd:cd, 01:00:0c:cc:cc:c0,                        01:00:0c:cc:cc:c1, 01:00:0c:cc:cc:c2, 01:00:0c:cc:cc:c3, 01:00:0c:cc:cc:c4,                        01:00:0c:cc:cc:c5, 01:00:0c:cc:cc:c6, 01:00:0c:cc:cc:c7", 
      "items": {
        "$ref": "MACAddress
      }, 
      "maxItems": 32, 
      "minItems": 0, 
      "required": false, 
      "title": "Disable BPDU filtering on this whitelist", 
      "type": "array"
    }, 
    "bpdu_filter_enable": {
      "default": true, 
      "description": "Indicates whether BPDU filter is enabled. BPDU filtering is enabled by default.", 
      "required": false, 
      "title": "BPDU filtering status", 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "dhcp_client_block_enabled": {
      "default": false, 
      "description": "Filters DHCP server and/or client traffic. DHCP server blocking is enabled and client blocking is disabled by default.", 
      "required": false, 
      "title": "Enable DHCP client block", 
      "type": "boolean"
    }, 
    "dhcp_client_block_v6_enabled": {
      "default": false, 
      "description": "Filters DHCP server and/or client IPv6 traffic. DHCP server blocking is enabled and client blocking is disabled by default.", 
      "required": false, 
      "title": "Enable DHCP client block v6", 
      "type": "boolean"
    }, 
    "dhcp_server_block_enabled": {
      "default": true, 
      "description": "Filters DHCP server and/or client traffic. DHCP server blocking is enabled and client blocking is disabled by default.", 
      "required": false, 
      "title": "Enable DHCP server block", 
      "type": "boolean"
    }, 
    "dhcp_server_block_v6_enabled": {
      "default": true, 
      "description": "Filters DHCP server and/or client IPv6 traffic. DHCP server blocking is enabled and client blocking is disabled by default.", 
      "required": false, 
      "title": "Enable DHCP server block v6", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "non_ip_traffic_block_enabled": {
      "default": false, 
      "description": "A flag to block all traffic except IP/(G)ARP/BPDU.", 
      "required": false, 
      "title": "Enable non IP traffic block", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "ra_guard_enabled": {
      "default": false, 
      "description": "Enable or disable Router Advertisement Guard.", 
      "required": false, 
      "title": "Enable Router Advertisement Guard", 
      "type": "boolean"
    }, 
    "rate_limits": {
      "$ref": "TrafficRateLimits, 
      "description": "Allows configuration of rate limits for broadcast and multicast traffic. Rate limiting is disabled by default", 
      "required": false, 
      "title": "Rate limiting configuration"
    }, 
    "rate_limits_enabled": {
      "default": false, 
      "description": "Enable or disable Rate Limits", 
      "required": false, 
      "title": "Enable Rate Limits", 
      "type": "boolean"
    }, 
    "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "search_dsl_name": [
    "security segment profile"
  ], 
  "title": "Segment Security Profile", 
  "type": "object"
}

SegmentSecurityProfileBindingMap (type)

{
  "additionalProperties": false, 
  "description": "Contains the binding relationship between segment and security profile.", 
  "extends": {
    "$ref": "SecurityProfileBindingMap
  }, 
  "id": "SegmentSecurityProfileBindingMap", 
  "module_id": "PolicySecurityProfileBinding", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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"
    }, 
    "segment_security_profile_path": {
      "description": "The policy path of the asscociated Segment Security profile", 
      "required": false, 
      "title": "Segment Security Profile Path", 
      "type": "string"
    }, 
    "spoofguard_profile_path": {
      "description": "The policy path of the asscociated SpoofGuard profile", 
      "required": false, 
      "title": "SpoofGuard Profile Path", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Security profile binding map for segment", 
  "type": "object"
}

SegmentSecurityProfileBindingMapListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "SegmentSecurityProfileBindingMapListRequestParameters", 
  "module_id": "PolicySecurityProfileBinding", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Segment security profile binding map request parameters", 
  "type": "object"
}

SegmentSecurityProfileBindingMapListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "SegmentSecurityProfileBindingMapListResult", 
  "module_id": "PolicySecurityProfileBinding", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "SegmentSecurityProfileBindingMap
      }, 
      "required": true, 
      "title": "Segment security profile binding map list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged collection of segment security profile binding maps", 
  "type": "object"
}

SegmentSecurityProfileListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "SegmentSecurityProfileListRequestParameters", 
  "module_id": "PolicySegmentSecurity", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Segment security profile request parameters", 
  "type": "object"
}

SegmentSecurityProfileListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "SegmentSecurityProfileListResult", 
  "module_id": "PolicySegmentSecurity", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "SegmentSecurityProfile
      }, 
      "required": true, 
      "title": "Segment Security profile list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged collection of segment security profiles", 
  "type": "object"
}

SegmentStateRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "Request parameters that represents a segment path and enforcement_point_path.", 
  "extends": {
    "$ref": "PolicyRuntimeRequestParameters
  }, 
  "id": "SegmentStateRequestParameters", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "configuration_state": {
      "enum": [
        "pending", 
        "in_progress", 
        "success", 
        "failed", 
        "partial_success", 
        "orphaned", 
        "unknown"
      ], 
      "required": false, 
      "title": "Configuration state of the segment on enforcement point", 
      "type": "string"
    }, 
    "enforcement_point_path": {
      "description": "enforcement point path, forward slashes must be escaped using %2F.", 
      "required": false, 
      "title": "String Path of the enforcement point", 
      "type": "string"
    }, 
    "source": {
      "$ref": "DataSourceType, 
      "required": false, 
      "title": "The data source, either realtime or cached. If not provided, cached data is returned."
    }
  }, 
  "title": "Request Parameters for Metadata Proxy Runtime Information", 
  "type": "object"
}

SegmentStatistics (type)

{
  "additionalProperties": false, 
  "description": "Segment statistics on specific Enforcement Point.", 
  "extends": {
    "$ref": "LogicalSwitchStatistics
  }, 
  "id": "SegmentStatistics", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "dropped_by_security_packets": {
      "$ref": "PacketsDroppedBySecurity, 
      "readonly": true, 
      "required": false
    }, 
    "last_update_timestamp": {
      "$ref": "EpochMsTimestamp, 
      "description": "Timestamp when the data was last updated; unset if data source has never updated the data.", 
      "readonly": true
    }, 
    "logical_switch_id": {
      "readonly": true, 
      "required": true, 
      "title": "The id of the logical Switch", 
      "type": "string"
    }, 
    "mac_learning": {
      "$ref": "MacLearningCounters, 
      "readonly": true, 
      "required": false
    }, 
    "rx_bytes": {
      "$ref": "DataCounter, 
      "readonly": true, 
      "required": false
    }, 
    "rx_packets": {
      "$ref": "DataCounter, 
      "readonly": true, 
      "required": false
    }, 
    "tx_bytes": {
      "$ref": "DataCounter, 
      "readonly": true, 
      "required": false
    }, 
    "tx_packets": {
      "$ref": "DataCounter, 
      "readonly": true, 
      "required": false
    }
  }, 
  "title": "Segment statistics on specific Enforcement Point", 
  "type": "object"
}

SegmentSubnet (type)

{
  "additionalProperties": false, 
  "id": "SegmentSubnet", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "dhcp_config": {
      "$ref": "SegmentDhcpConfig, 
      "description": "Additional DHCP configuration for current subnet.", 
      "required": false, 
      "title": "Additional DHCP configuration"
    }, 
    "dhcp_ranges": {
      "description": "DHCP address ranges are used for dynamic IP allocation. Supports address range and CIDR formats. First valid host address from the first value is assigned to DHCP server IP address. Existing values cannot be deleted or modified, but additional DHCP ranges can be added.", 
      "items": {
        "$ref": "IPElement
      }, 
      "minItems": 1, 
      "required": false, 
      "title": "DHCP address ranges for dynamic IP allocation", 
      "type": "array"
    }, 
    "gateway_address": {
      "description": "Gateway IP address in CIDR format for both IPv4 and IPv6.", 
      "format": "ip-cidr-block", 
      "title": "Gateway IP address.", 
      "type": "string"
    }, 
    "network": {
      "description": "Network CIDR for this subnet calculated from gateway_addresses and prefix_len.", 
      "readonly": true, 
      "title": "Network CIDR for subnet", 
      "type": "string"
    }
  }, 
  "title": "Subnet configuration for segment", 
  "type": "object"
}

SelectableResourceReference (type)

{
  "extends": {
    "$ref": "ResourceReference
  }, 
  "id": "SelectableResourceReference", 
  "module_id": "ClusterRestore", 
  "properties": {
    "is_valid": {
      "description": "Will be set to false if the referenced NSX resource has been deleted.", 
      "readonly": true, 
      "required": false, 
      "title": "Target validity", 
      "type": "boolean"
    }, 
    "selected": {
      "required": true, 
      "title": "Set to true if this resource has been selected to be acted upon", 
      "type": "boolean"
    }, 
    "target_display_name": {
      "description": "Display name of the NSX resource.", 
      "maxLength": 255, 
      "readonly": true, 
      "required": false, 
      "title": "Target display name", 
      "type": "string"
    }, 
    "target_id": {
      "description": "Identifier of the NSX resource.", 
      "maxLength": 64, 
      "readonly": false, 
      "required": false, 
      "title": "Target ID", 
      "type": "string"
    }, 
    "target_type": {
      "description": "Type of the NSX resource.", 
      "maxLength": 255, 
      "readonly": false, 
      "required": false, 
      "title": "Target type", 
      "type": "string"
    }
  }, 
  "title": "Resources to take action on", 
  "type": "object"
}

SelfResourceLink (type)

{
  "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
  "extends": {
    "$ref": "ResourceLink
  }, 
  "id": "SelfResourceLink", 
  "module_id": "Common", 
  "properties": {
    "action": {
      "readonly": true, 
      "title": "Optional action", 
      "type": "string"
    }, 
    "href": {
      "readonly": true, 
      "required": true, 
      "title": "Link to resource", 
      "type": "string"
    }, 
    "rel": {
      "description": "Custom relation type (follows RFC 5988 where appropriate definitions exist)", 
      "readonly": true, 
      "required": true, 
      "title": "Link relation type", 
      "type": "string"
    }
  }, 
  "title": "Link to this resource", 
  "type": "object"
}

Service (type)

{
  "description": "Used while defining a CommunicationEntry. A service may have multiple service entries.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "Service", 
  "module_id": "Policy", 
  "policy_hierarchical_children": [
    "ChildServiceEntry"
  ], 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "is_default": {
      "default": false, 
      "description": "The flag, if true, indicates that service is created in the system by default. Such default services can't be modified/deleted.", 
      "readonly": true, 
      "title": "Flag for default services", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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
      }, 
      "maxItems": 50, 
      "title": "Service type", 
      "type": "array"
    }, 
    "service_type": {
      "title": "Type of service, EITHER or NON_ETHER", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Contains the information related to a service", 
  "type": "object"
}

ServiceEntry (type)

{
  "abstract": true, 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "ServiceEntry", 
  "module_id": "Policy", 
  "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: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": [
        "IPProtocolServiceEntry", 
        "IGMPTypeServiceEntry", 
        "ICMPTypeServiceEntry", 
        "ALGTypeServiceEntry", 
        "L4PortSetServiceEntry", 
        "EtherTypeServiceEntry", 
        "NestedServiceServiceEntry"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "A Service entry that describes traffic", 
  "type": "object"
}

ServiceEntryListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "ServiceEntryListRequestParameters", 
  "module_id": "Policy", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Service entry list request parameters", 
  "type": "object"
}

ServiceEntryListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ServiceEntryListResult", 
  "module_id": "Policy", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "ServiceEntry
      }, 
      "required": true, 
      "title": "Service entry list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of Service entries", 
  "type": "object"
}

ServiceInstanceEndpoint (type)

{
  "additionalProperties": false, 
  "description": "A ServiceInstanceEndpoint belongs to one ByodPolicyServiceInstance and is attached to one ServiceInterface. A ServiceInstanceEndpoint represents a redirection target for a RedirectionPolicy.", 
  "extends": {
    "$ref": "BaseEndpoint
  }, 
  "id": "ServiceInstanceEndpoint", 
  "module_id": "PolicyServiceInsertion", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ServiceInstanceEndpoint"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": [
        "VirtualEndpoint", 
        "ServiceInstanceEndpoint"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "service_interface_path": {
      "description": "Path of Service Interface to which this ServiceInstanceEndpoint is connected.", 
      "readonly": false, 
      "required": true, 
      "title": "Service Interface path", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "target_ips": {
      "description": "IPs where either inbound or outbound traffic is to be redirected.", 
      "items": {
        "$ref": "IPInfo
      }, 
      "maxItems": 1, 
      "minItems": 1, 
      "required": true, 
      "title": "IP addresses to redirect the traffic to", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Service EndPoint for Byod Policy Service Instance", 
  "type": "object"
}

ServiceInterface (type)

{
  "additionalProperties": false, 
  "description": "Service interface configuration for internal connectivity.", 
  "extends": {
    "$ref": "BaseTier0Interface
  }, 
  "id": "ServiceInterface", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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"
    }, 
    "subnets": {
      "description": "Specify IP address and network prefix for interface.", 
      "items": {
        "$ref": "InterfaceSubnet
      }, 
      "minItems": 1, 
      "required": true, 
      "title": "IP address and subnet specification for interface", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Service interface configuration", 
  "type": "object"
}

ServiceInterfaceListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ServiceInterfaceListResult", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "ServiceInterface
      }, 
      "required": true, 
      "title": "Service Interface list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged collection of Service Interfaces", 
  "type": "object"
}

ServiceListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "ServiceListRequestParameters", 
  "module_id": "Policy", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "default_service": {
      "description": "If set to true, then it will display only default services. If set to false, then it will display all user defined services. If it is not provided, then complete (default as well as user defined) list of services will be displayed.", 
      "title": "Fetch all default services", 
      "type": "boolean"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Service list request parameters", 
  "type": "object"
}

ServiceListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "ServiceListResult", 
  "module_id": "Policy", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "Service
      }, 
      "required": true, 
      "title": "Service list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of Services", 
  "type": "object"
}

ServiceReference (type)

{
  "description": "An anchor object representing the intent to consume a given 3rd party service.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "ServiceReference", 
  "module_id": "PolicyServiceInsertion", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "enabled": {
      "default": true, 
      "description": "A Service's operational state can be enabled or disabled. Note that would work only for NetX type of services and would not work for Guest Introsp- ection type of Services. TRUE - The Service should be enabled FALSE - The Service should be disabled", 
      "readonly": false, 
      "required": false, 
      "title": "Operational state of the Service.", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "partner_service_name": {
      "description": "Unique name of Partner Service to be consumed for redirection.", 
      "required": true, 
      "title": "Name of Partner Service", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "An anchor object representing the intent to consume a given 3rd party service.", 
  "type": "object"
}

ServiceSegment (type)

{
  "additionalProperties": false, 
  "description": "Service Segment configuration to attach Service Insertion VM.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "ServiceSegment", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "lr_paths": {
      "description": "Policy paths of logical routers or ports | to which this Service Segment can be connected.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Policy paths of logical routers", 
      "type": "array"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "transport_zone_path": {
      "description": "Policy path to transport zone. Only overlay transport zone is supported.", 
      "required": true, 
      "title": "Policy path to the transport zone", 
      "type": "string"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Service Segment configuration", 
  "type": "object"
}

ServiceType (type)

{
  "enum": [
    "MGMT_CLUSTER", 
    "MGMT_PLANE", 
    "API", 
    "NOTIFICATION_COLLECTOR", 
    "SYSLOG_SERVER", 
    "RSYSLOG_CLIENT", 
    "APH", 
    "GLOBAL_MANAGER", 
    "LOCAL_MANAGER", 
    "CLIENT_AUTH", 
    "RMQ"
  ], 
  "id": "ServiceType", 
  "module_id": "CertificateManager", 
  "title": "Supported service types, that are using certificates.", 
  "type": "string"
}

SessionTimerProfileBindingListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "SessionTimerProfileBindingListResult", 
  "module_id": "PolicyProfile", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "SessionTimerProfileBindingMap
      }, 
      "required": true, 
      "title": "Session timer profile binding maps list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of session timer profile binding maps", 
  "type": "object"
}

SessionTimerProfileBindingMap (type)

{
  "additionalProperties": false, 
  "description": "This entity will be used to establish association between Session Timer profile and Logical Routers.", 
  "extends": {
    "$ref": "ProfileBindingMap
  }, 
  "id": "SessionTimerProfileBindingMap", 
  "module_id": "PolicyProfile", 
  "polymorphic-type-descriptor": {
    "type-identifier": "SessionTimerProfileBindingMap"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "profile_path": {
      "description": "PolicyPath of associated Profile", 
      "required": true, 
      "title": "Profile Path", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Policy Session Timer Profile binding map", 
  "type": "object"
}

SetFields (type)

{
  "additionalProperties": false, 
  "description": "Set Fields is an action to set fields of the source event.", 
  "extends": {
    "$ref": "Action
  }, 
  "id": "SetFields", 
  "module_id": "PolicyReaction", 
  "polymorphic-type-descriptor": {
    "type-identifier": "SetFields"
  }, 
  "properties": {
    "field_settings": {
      "description": "Field Settings.", 
      "items": {
        "$ref": "FieldSetting
      }, 
      "minItems": 1, 
      "title": "Field Settings", 
      "type": "array"
    }, 
    "resource_type": {
      "description": "Reaction Action resource type.", 
      "enum": [
        "PatchResources", 
        "SetFields"
      ], 
      "required": true, 
      "title": "Resource Type", 
      "type": "string"
    }
  }, 
  "title": "Set Fields", 
  "type": "object"
}

SftpProtocol (type)

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

Site (type)

{
  "additionalProperties": false, 
  "description": "Site represents an NSX deployment having its own set of NSX clusters and transport nodes. It may correspond to a Data Center, VMC deployment, or NSX-Cloud deployment managed via CSM.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "Site", 
  "module_id": "PolicyEnforcementPointManagement", 
  "policy_hierarchical_children": [
    "ChildEnforcementPoint"
  ], 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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"
    }, 
    "fail_if_rtep_misconfigured": {
      "default": true, 
      "description": "Both the local site and the remote site must have edge clusters correctly configured and remote tunnel endpoint (RTEP) interfaces must be defined, or onboarding will fail.", 
      "title": "Fail onboarding if RTEPs misconfigured", 
      "type": "boolean"
    }, 
    "fail_if_rtt_exceeded": {
      "default": true, 
      "description": "Fail onboarding if maximum RTT exceeded.", 
      "title": "Fail onboarding if maximum RTT exceeded", 
      "type": "boolean"
    }, 
    "federation_config": {
      "$ref": "GmFederationSiteConfig, 
      "description": "System managed federation config.", 
      "readonly": true, 
      "title": "Federation releated config"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "maximum_rtt": {
      "default": 250, 
      "description": "If provided and fail_if_rtt_exceeded is true, onboarding of the site will fail if measured RTT is greater than this value.", 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum acceptable packet round trip time (RTT)", 
      "type": "integer"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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"
    }, 
    "site_connection_info": {
      "description": "To onboard a site, the connection information (username, password, and API thumbprint) for at least one NSX manager node in the remote site must be provided. Once the site has been successfully onboarded, the site_connection_info is discarded and authentication to the remote site occurs using an X.509 client certificate.", 
      "items": {
        "$ref": "SiteNodeConnectionInfo
      }, 
      "maxItems": 3, 
      "title": "Connection information", 
      "type": "array"
    }, 
    "site_number": {
      "readonly": true, 
      "title": "12-bit system generated site number", 
      "type": "integer"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Site", 
  "type": "object"
}

SiteActionParameters (type)

{
  "additionalProperties": false, 
  "description": "If force=true then site will be deleted even if not reachable. NOTE - Use this with caution as Global Manager will go ahead and        offboard the site forcefully.", 
  "id": "SiteActionParameters", 
  "module_id": "PolicySiteGM", 
  "properties": {
    "force": {
      "required": false, 
      "type": "boolean"
    }
  }, 
  "title": "Paramters for Site delete operation", 
  "type": "object"
}

SiteAllocationIndexForEdge (type)

{
  "additionalProperties": false, 
  "description": "Index for cross site allocation for edge cluster and its members referred by gateway.", 
  "id": "SiteAllocationIndexForEdge", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "index": {
      "description": "Unqiue edge cluster node index across sites based on stretch of the Gateway. For example, if a Gateway is streched to sites S1 with one edge cluster of 3 nodes and site S2 with one edge cluster of 2 nodes, the in the Global Manager will allocate the index for 5 edge nodes and 2 cluster in the rage 0 to 7.", 
      "readonly": true, 
      "title": "Unique index across sites for gateway span", 
      "type": "integer"
    }, 
    "target_resource_path": {
      "readonly": true, 
      "title": "Edge cluster or edge node path", 
      "type": "string"
    }
  }, 
  "title": "Allocation index for edge\n", 
  "type": "object"
}

SiteCleanupPending (type)

{
  "additionalProperties": false, 
  "description": "SiteCleanupPending contains information about the resource cleanup from sites.", 
  "id": "SiteCleanupPending", 
  "module_id": "GmSiteCleanupPending", 
  "properties": {
    "marked_for_delete": {
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted.", 
      "readonly": true, 
      "title": "Indicates whether the resource is marked for deletion", 
      "type": "boolean"
    }, 
    "pending_sites": {
      "description": "List of SpanSiteInfos representing the strech of the entity.", 
      "items": {
        "$ref": "SpanSiteInfo
      }, 
      "readonly": true, 
      "title": "List of SpanSiteInfos", 
      "type": "array"
    }, 
    "resource_path": {
      "description": "Policy resource which is either marked for delete or in process of deletion from site.", 
      "readonly": true, 
      "title": "Policy path of an resource.", 
      "type": "string"
    }
  }, 
  "title": "Details for cleanup of resource.", 
  "type": "object"
}

SiteCleanupPendingListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "SiteCleanupPendingListRequestParameters", 
  "module_id": "GmSiteCleanupPending", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "intent_path": {
      "description": "String Path of a resource. Can pass multiple values.", 
      "required": false, 
      "title": "String Path of a resource.", 
      "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": "SiteCleanupPending list request parameters", 
  "type": "object"
}

SiteCleanupPendingListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "SiteCleanupPendingListResult", 
  "module_id": "GmSiteCleanupPending", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "SiteCleanupPending
      }, 
      "readonly": true, 
      "title": "SiteCleanupPending list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged collection of SiteCleanupPending", 
  "type": "object"
}

SiteFederationConfig (type)

{
  "additionalProperties": false, 
  "description": "Site fedeation configuration.", 
  "id": "SiteFederationConfig", 
  "module_id": "PolicySiteGM", 
  "properties": {
    "rtep_ips": {
      "items": {
        "$ref": "IPAddress
      }, 
      "readonly": true, 
      "title": "Remote tunnel endpoint IP addresses", 
      "type": "array"
    }, 
    "site_id": {
      "readonly": true, 
      "title": "Site UUID", 
      "type": "string"
    }, 
    "site_index": {
      "readonly": true, 
      "title": "Unique site index allocated (from range 0-4095)", 
      "type": "integer"
    }, 
    "site_path": {
      "readonly": true, 
      "title": "Site path", 
      "type": "string"
    }
  }, 
  "title": "Site fedeation configuration", 
  "type": "object"
}

SiteListRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "Site list request parameters.", 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "SiteListRequestParameters", 
  "module_id": "PolicyEnforcementPointManagement", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Site List Request Parameters", 
  "type": "object"
}

SiteListResult (type)

{
  "additionalProperties": false, 
  "description": "Paged Collection of Sites.", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "SiteListResult", 
  "module_id": "PolicyEnforcementPointManagement", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Site list result.", 
      "items": {
        "$ref": "Site
      }, 
      "required": true, 
      "title": "Site List Result", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of Sites", 
  "type": "object"
}

SiteNodeConnectionInfo (type)

{
  "additionalProperties": false, 
  "description": "Credential info to connect to a node in the federated remote site.", 
  "id": "SiteNodeConnectionInfo", 
  "module_id": "PolicyEnforcementPointManagement", 
  "properties": {
    "fqdn": {
      "description": "Please specify the fqdn of the Management Node of your site.", 
      "required": true, 
      "title": "Fully Qualified Domain Name of the Management Node", 
      "type": "string"
    }, 
    "password": {
      "description": "Password to connect to Site's Local Manager.", 
      "sensitive": true, 
      "title": "Password", 
      "type": "string"
    }, 
    "thumbprint": {
      "description": "Thumbprint of Site's Local Manager in the form of a SHA-256 hash represented in lower case HEX.", 
      "title": "Thumbprint of Enforcement Point", 
      "type": "string"
    }, 
    "username": {
      "description": "Username to connect to Site's Local Manager.", 
      "title": "Username", 
      "type": "string"
    }
  }, 
  "title": "Site Node Connection Info", 
  "type": "object"
}

SiteOnboardingPreference (type)

{
  "additionalProperties": false, 
  "description": "User onboarding preference for site.", 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "SiteOnboardingPreference", 
  "module_id": "GmConfigOnboarding", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ignore_import": {
      "description": "Represents user's decision to ignore onboarding option for a site. User will not be shown onboarding message or will failing onboarding when ignore status is set to 'true'.", 
      "readonly": true, 
      "required": true, 
      "title": "Ignore Import Preference", 
      "type": "boolean"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "site_id": {
      "description": "Unique site identifier.", 
      "readonly": true, 
      "required": false, 
      "title": "Site Identifier", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "User Onboarding Preference", 
  "type": "object"
}

SnmpServiceProperties (type)

{
  "additionalProperties": false, 
  "id": "SnmpServiceProperties", 
  "module_id": "CentralNodeConfig", 
  "properties": {
    "communities": {
      "items": {
        "type": "string"
      }, 
      "maxItems": 1, 
      "required": false, 
      "title": "SNMP v1, v2c community strings", 
      "type": "array"
    }, 
    "start_on_boot": {
      "required": true, 
      "title": "Start when system boots", 
      "type": "boolean"
    }, 
    "v2_configured": {
      "readonly": true, 
      "title": "SNMP v2 is configured or not", 
      "type": "boolean"
    }, 
    "v3_auth_protocol": {
      "default": "SHA1", 
      "enum": [
        "SHA1"
      ], 
      "required": true, 
      "title": "SNMP v3 auth protocol", 
      "type": "string"
    }, 
    "v3_configured": {
      "readonly": true, 
      "title": "SNMP v3 is configured or not", 
      "type": "boolean"
    }, 
    "v3_priv_protocol": {
      "default": "AES128", 
      "enum": [
        "AES128"
      ], 
      "required": true, 
      "title": "SNMP v3 private protocol", 
      "type": "string"
    }, 
    "v3_users": {
      "description": "SNMP v3 users information", 
      "items": {
        "$ref": "SnmpV3User
      }, 
      "maxItems": 1, 
      "title": "V3 users", 
      "type": "array"
    }
  }, 
  "title": "SNMP Service properties", 
  "type": "object"
}

SnmpV3User (type)

{
  "description": "SNMP v3 user properties", 
  "id": "SnmpV3User", 
  "module_id": "CentralNodeConfig", 
  "properties": {
    "auth_password": {
      "description": "SNMP v3 user auth password", 
      "required": false, 
      "sensitive": true, 
      "title": "Auth password", 
      "type": "string"
    }, 
    "priv_password": {
      "description": "SNMP v3 user private password", 
      "required": false, 
      "sensitive": true, 
      "title": "Private password", 
      "type": "string"
    }, 
    "user_id": {
      "description": "SNMP v3 user ID", 
      "required": true, 
      "title": "User ID", 
      "type": "string"
    }
  }, 
  "title": "SNMP v3 user", 
  "type": "object"
}

Source (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "description": "Source that is logically deemed to be the \"object\" upon which the Event in question initially occurred upon. The Source is responsible for providing information of the occurred event. Some example sources include: - Resource. - API.", 
  "id": "Source", 
  "module_id": "PolicyReaction", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "resource_type"
  }, 
  "properties": {
    "resource_type": {
      "description": "Event Source resource type.", 
      "enum": [
        "ResourceOperation", 
        "ApiRequestBody"
      ], 
      "required": true, 
      "title": "Resource Type", 
      "type": "string"
    }
  }, 
  "title": "Event Source", 
  "type": "object"
}

SourceFieldEvaluation (type)

{
  "additionalProperties": false, 
  "description": "Source Field Evaluation represents an evaluation on resource fields. A source field evaluation will be evaluated against an Event Source which is of type Resource Operation. For instance, the attribute constraint could be related to the necessity that one of the source fields equals one of the specified values.", 
  "extends": {
    "$ref": "Evaluation
  }, 
  "id": "SourceFieldEvaluation", 
  "module_id": "PolicyReaction", 
  "polymorphic-type-descriptor": {
    "type-identifier": "SourceFieldEvaluation"
  }, 
  "properties": {
    "expected": {
      "description": "Expected values necessary to apply the specified operation on the source field value.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 1, 
      "minItems": 1, 
      "required": true, 
      "title": "Operator Arguments", 
      "type": "array"
    }, 
    "field_pointer": {
      "description": "Field in the form of a pointer, describing the location of the attribute within the source of the event.", 
      "required": true, 
      "title": "Field Pointer", 
      "type": "string"
    }, 
    "operator": {
      "description": "Logical operator.", 
      "enum": [
        "EQ", 
        "NOT_EQ"
      ], 
      "required": true, 
      "title": "Logical Operator", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "Criterion Evaluation resource type.", 
      "enum": [
        "SourceFieldEvaluation"
      ], 
      "required": true, 
      "title": "Resource Type", 
      "type": "string"
    }
  }, 
  "title": "Source Field Evaluation", 
  "type": "object"
}

SourceIpPersistencePurge (type)

{
  "additionalProperties": false, 
  "description": "If the persistence table is full and a new connection without a matching persistence entry is received, then by default(FULL) oldest persistence entries are purged from the table to make space for new entries. Each time purging gets triggered, a small percentage of the entries are purged. If purging is disabled(NO_PURGE) and a new incoming connection requires a persistence entry to be created, then that connection is rejected even though backend servers are available.", 
  "enum": [
    "NO_PURGE", 
    "FULL"
  ], 
  "id": "SourceIpPersistencePurge", 
  "module_id": "LoadBalancer", 
  "title": "source ip persistence purge setting", 
  "type": "string"
}

Span (type)

{
  "additionalProperties": false, 
  "description": "Represents the strech information for a federated entity available only on local manager.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "Span", 
  "module_id": "PolicySitesSpan", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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"
    }, 
    "sites": {
      "description": "List of SpanSiteInfos representing the strech of the entity.", 
      "items": {
        "$ref": "SpanSiteInfo
      }, 
      "readonly": true, 
      "title": "List of SpanSiteInfos", 
      "type": "array"
    }, 
    "span_leader": {
      "description": "Represents Policy resource type streached entity's span leader.", 
      "readonly": true, 
      "title": "Policy resource type of span leader", 
      "type": "string"
    }, 
    "span_resource": {
      "description": "Represents Policy resource path of streached entity.", 
      "readonly": true, 
      "title": "Policy resource path", 
      "type": "string"
    }, 
    "span_resource_type": {
      "description": "Policy resource type of the streached entity.", 
      "readonly": true, 
      "title": "Policy resource type", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Represents strech information for federated entity.", 
  "type": "object"
}

SpanSiteInfo (type)

{
  "additionalProperties": false, 
  "description": "Represents the Site resource information for a Span entity including both the internal id as well as the site path.", 
  "id": "SpanSiteInfo", 
  "module_id": "PolicySitesSpan", 
  "properties": {
    "site_id": {
      "description": "Site UUID representing the Site resource", 
      "readonly": true, 
      "title": "Internal ID of the Site resource", 
      "type": "string"
    }, 
    "site_path": {
      "description": "Path of the Site resource", 
      "readonly": true, 
      "title": "Path of the Site resource", 
      "type": "string"
    }
  }, 
  "title": "Represents Site resource for Span entity.", 
  "type": "object"
}

SpoofGuardProfile (type)

{
  "additionalProperties": false, 
  "description": "SpoofGuard is a tool that is designed to prevent virtual machines in your environment from sending traffic with IP addresses which are not authorized to send traffic from. A SpoofGuard policy profile once enabled blocks the traffic determined to be spoofed.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "SpoofGuardProfile", 
  "module_id": "PolicySpoofGuard", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "address_binding_whitelist": {
      "default": false, 
      "description": "If true, enable the SpoofGuard, which only allows VM sending traffic with the IPs in the whitelist.", 
      "required": true, 
      "title": "Enable SpoofGuard", 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "search_dsl_name": [
    "spoof guard segment profile"
  ], 
  "title": "SpoofGuard Profile", 
  "type": "object"
}

SpoofGuardProfileListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "SpoofGuardProfileListRequestParameters", 
  "module_id": "PolicySpoofGuard", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "SpoofGuard profile request parameters", 
  "type": "object"
}

SpoofGuardProfileListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "SpoofGuardProfileListResult", 
  "module_id": "PolicySpoofGuard", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "SpoofGuardProfile
      }, 
      "required": true, 
      "title": "SpoofGuard profile list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged collection of SpoofGuard profiles", 
  "type": "object"
}

SshKeyBaseProperties (type)

{
  "additionalProperties": {}, 
  "id": "SshKeyBaseProperties", 
  "properties": {
    "label": {
      "required": true, 
      "title": "SSH key label (used to identify the key)", 
      "type": "string"
    }, 
    "password": {
      "required": false, 
      "sensitive": true, 
      "title": "Current password for user (required for users root and admin)", 
      "type": "string"
    }
  }, 
  "type": "object"
}

SshKeyProperties (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "SshKeyBaseProperties
  }, 
  "id": "SshKeyProperties", 
  "properties": {
    "label": {
      "required": true, 
      "title": "SSH key label (used to identify the key)", 
      "type": "string"
    }, 
    "password": {
      "required": false, 
      "sensitive": true, 
      "title": "Current password for user (required for users root and admin)", 
      "type": "string"
    }, 
    "type": {
      "pattern": "^(ecdsa-sha2-nistp256|ecdsa-sha2-nistp384|ecdsa-sha2-nistp521|ssh-dss|ssh-ed25519|ssh-rsa)$", 
      "required": true, 
      "title": "SSH key type", 
      "type": "string"
    }, 
    "value": {
      "required": true, 
      "title": "SSH key value", 
      "type": "string"
    }
  }, 
  "type": "object"
}

SshKeyPropertiesListResult (type)

{
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "SshKeyPropertiesListResult", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "SshKeyProperties
      }, 
      "required": true, 
      "title": "SSH key properties query results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "SSH key properties query results", 
  "type": "object"
}

SshServiceProperties (type)

{
  "additionalProperties": false, 
  "id": "SshServiceProperties", 
  "properties": {
    "start_on_boot": {
      "required": true, 
      "title": "Start service when system boots", 
      "type": "boolean"
    }
  }, 
  "title": "SSH Service properties", 
  "type": "object"
}

SslCipher (type)

{
  "additionalProperties": false, 
  "enum": [
    "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256", 
    "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384", 
    "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA", 
    "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA", 
    "TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA", 
    "TLS_ECDH_RSA_WITH_AES_256_CBC_SHA", 
    "TLS_RSA_WITH_AES_256_CBC_SHA", 
    "TLS_RSA_WITH_AES_128_CBC_SHA", 
    "TLS_RSA_WITH_3DES_EDE_CBC_SHA", 
    "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA", 
    "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256", 
    "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384", 
    "TLS_RSA_WITH_AES_128_CBC_SHA256", 
    "TLS_RSA_WITH_AES_128_GCM_SHA256", 
    "TLS_RSA_WITH_AES_256_CBC_SHA256", 
    "TLS_RSA_WITH_AES_256_GCM_SHA384", 
    "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA", 
    "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256", 
    "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256", 
    "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384", 
    "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384", 
    "TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA", 
    "TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256", 
    "TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256", 
    "TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384", 
    "TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384", 
    "TLS_ECDH_RSA_WITH_AES_128_CBC_SHA", 
    "TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256", 
    "TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256", 
    "TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384", 
    "TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384"
  ], 
  "id": "SslCipher", 
  "module_id": "LoadBalancer", 
  "title": "SSL cipher", 
  "type": "string"
}

SslCipherGroup (type)

{
  "additionalProperties": false, 
  "enum": [
    "BALANCED", 
    "HIGH_SECURITY", 
    "HIGH_COMPATIBILITY", 
    "CUSTOM"
  ], 
  "id": "SslCipherGroup", 
  "module_id": "LoadBalancer", 
  "title": "SSL cipher group", 
  "type": "string"
}

SslProtocol (type)

{
  "additionalProperties": false, 
  "enum": [
    "SSL_V2", 
    "SSL_V3", 
    "TLS_V1", 
    "TLS_V1_1", 
    "TLS_V1_2"
  ], 
  "id": "SslProtocol", 
  "module_id": "LoadBalancer", 
  "title": "SSL protocol", 
  "type": "string"
}

SslTrustObjectData (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "SslTrustObjectData", 
  "module_id": "TempPolicyLoadBalancer", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "key_algo": {
      "description": "Key algorithm contained in this certificate", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "passphrase": {
      "description": "Password for private key encryption", 
      "readonly": false, 
      "required": false, 
      "sensitive": true, 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "pem_encoded": {
      "description": "pem encoded certificate data", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }, 
    "private_key": {
      "description": "private key data", 
      "readonly": false, 
      "required": false, 
      "sensitive": true, 
      "type": "string"
    }, 
    "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "type": "object"
}

StageUpgradeRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "Parameters specified during upgrade staging request", 
  "id": "StageUpgradeRequestParameters", 
  "module_id": "Upgrade", 
  "properties": {
    "component_type": {
      "description": "Type of the component", 
      "readonly": false, 
      "required": false, 
      "title": "Component type", 
      "type": "string"
    }
  }, 
  "title": "Stage upgrade request parameters", 
  "type": "object"
}

StandaloneHostIdfwConfiguration (type)

{
  "additionalProperties": false, 
  "description": "Idfw configuration for enable/disable idfw on standalone hosts.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "StandaloneHostIdfwConfiguration", 
  "module_id": "PolicyFirewallConfiguration", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "idfw_enabled": {
      "description": "If set to true, Idfw is enabled for standalone hosts", 
      "readonly": false, 
      "required": true, 
      "title": "Idfw enabled flag", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Standalone host idfw configuration", 
  "type": "object"
}

StatItem (type)

{
  "additionalProperties": false, 
  "description": "Displayed as a single number. It can be used to show the characteristics of entities such as Logical Switches, Firewall Rules, and so on. For example, number of logical switches and their admin states.", 
  "id": "StatItem", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "properties": {
    "drilldown_id": {
      "description": "Id of drilldown widget, if any. Id should be a valid id of an existing widget.", 
      "title": "Id of drilldown widget", 
      "type": "string"
    }, 
    "tooltip": {
      "description": "Multi-line text to be shown on tooltip while hovering over the stat.", 
      "items": {
        "$ref": "Tooltip
      }, 
      "minItems": 0, 
      "title": "Multi-line tooltip", 
      "type": "array"
    }, 
    "total": {
      "description": "If expression for total is specified, it evaluates it. Total can be omitted if not needed to be shown.", 
      "title": "Total", 
      "type": "string"
    }, 
    "value": {
      "description": "Expression for stat to be displayed.", 
      "maxLength": 1024, 
      "required": true, 
      "title": "Stat", 
      "type": "string"
    }
  }, 
  "title": "Statistic of an entity", 
  "type": "object"
}

StaticARPConfig (type)

{
  "additionalProperties": false, 
  "description": "Contains Static ARP configuration for Segment.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "StaticARPConfig", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ip_address": {
      "$ref": "IPAddress, 
      "required": true, 
      "title": "IP Address"
    }, 
    "mac_address": {
      "$ref": "MACAddress, 
      "required": true, 
      "title": "MAC Address"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Static ARP Config", 
  "type": "object"
}

StaticFilter (type)

{
  "additionalProperties": false, 
  "id": "StaticFilter", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "properties": {
    "display_name": {
      "description": "display name to be shown in the drop down for static filter.", 
      "maxLength": 1024, 
      "title": "Display name for static filter", 
      "type": "string"
    }, 
    "value": {
      "description": "Value of static filter inside dropdown filter.", 
      "title": "Value of static filter", 
      "type": "string"
    }
  }, 
  "title": "Static filters", 
  "type": "object"
}

StaticRouteBfdPeer (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "StaticRouteBfdPeer", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "bfd_profile_path": {
      "description": "Bfd Profile is not supported for IPv6 networks.", 
      "title": "Policy path to Bfd Profile", 
      "type": "string"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "enabled": {
      "default": true, 
      "description": "Flag to enable BFD peer.", 
      "title": "Enable BFD Peer", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "peer_address": {
      "description": "Only IPv4 addresses are supported. Only a single BFD config per peer address is allowed.", 
      "required": true, 
      "title": "IP Address of static route next hop peer", 
      "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"
    }, 
    "scope": {
      "description": "Represents the array of policy paths of locale services where this BFD peer should get relalized on. The locale service service and this BFD peer must belong to the same router. Default scope is empty.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Array of policy paths of locale services", 
      "type": "array"
    }, 
    "source_addresses": {
      "description": "Array of Tier0 external interface IP addresses. BFD peering is established from all these source addresses to the neighbor specified in peer_address. Only IPv4 addresses are supported.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 8, 
      "minItems": 0, 
      "title": "List of source IP addresses", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Static Route Bidirectional Forwarding Detection Peer", 
  "type": "object"
}

StaticRouteBfdPeerListResult (type)

{
  "additionalProperties": false, 
  "description": "Paged collection of StaticRouteBfdPeer.", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "StaticRouteBfdPeerListResult", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "StaticRouteBfdPeer list results.", 
      "items": {
        "$ref": "StaticRouteBfdPeer
      }, 
      "required": true, 
      "title": "StaticRouteBfdPeer list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Colleciton of StaticRouteBfdPeer", 
  "type": "object"
}

StaticRoutes (type)

{
  "additionalProperties": false, 
  "description": "Static routes configuration on Tier-0 or Tier-1.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "StaticRoutes", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "enabled_on_secondary": {
      "default": false, 
      "description": "When false or by default northbound routes are configured only on the primary location and not on secondary location. When true, the static route will also be configured on a secondary location. Secondary location prefers route learned from the primary location and enabling this flag secondary location can override this. This flag is not applicable if all sites are primary.", 
      "title": "Flag to plumb route on secondary site", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "network": {
      "$ref": "IPElement, 
      "description": "Specify network address in CIDR format.", 
      "required": true, 
      "title": "Network address in CIDR format"
    }, 
    "next_hops": {
      "description": "Specify next hop routes for network.", 
      "items": {
        "$ref": "RouterNexthop
      }, 
      "minItems": 1, 
      "required": true, 
      "title": "Next hop routes for network", 
      "type": "array"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Static routes configuration on Tier-0 or on Tier-1", 
  "type": "object"
}

StaticRoutesListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "StaticRoutesListRequestParameters", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Static Routes list request parameters", 
  "type": "object"
}

StaticRoutesListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "StaticRoutesListResult", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "StaticRoutes
      }, 
      "required": true, 
      "title": "Static Routes list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged collection of Static Routes", 
  "type": "object"
}

StatisticsRequestParameters (type)

{
  "description": "Request parameters that represents an enforcement point path. A request on statistics can be parameterized with this path and will be evaluated as follows: - no enforcement point path specified: the request is evaluated on all enforcement points. - {enforcement_point_path}: the request is evaluated only on the given enforcement point.", 
  "id": "StatisticsRequestParameters", 
  "module_id": "PolicyBaseStatistics", 
  "properties": {
    "enforcement_point_path": {
      "description": "enforcement point path, forward slashes must be escaped using %2F.", 
      "required": false, 
      "title": "String Path of the enforcement point", 
      "type": "string"
    }
  }, 
  "title": "Statistics Request Parameters", 
  "type": "object"
}

StatsConfiguration (type)

{
  "additionalProperties": false, 
  "description": "Represents configuration of a statistic for an entity. Example, number of logical switches and their admin states.", 
  "extends": {
    "$ref": "WidgetConfiguration
  }, 
  "id": "StatsConfiguration", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "polymorphic-type-descriptor": {
    "type-identifier": "StatsConfiguration"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "datasources": {
      "description": "The 'datasources' represent the sources from which data will be fetched. Currently, only NSX-API is supported as a 'default' datasource. An example of specifying 'default' datasource along with the urls to fetch data from is given at 'example_request' section of 'CreateWidgetConfiguration' API.", 
      "items": {
        "$ref": "Datasource
      }, 
      "minItems": 0, 
      "title": "Array of Datasource Instances with their relative urls", 
      "type": "array"
    }, 
    "default_filter_value": {
      "description": "Default filter values to be passed to datasources. This will be used when the report is requested without filter values.", 
      "items": {
        "$ref": "DefaultFilterValue
      }, 
      "title": "Default filter value to be passed to datasources", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "description": "Title of the widget. If display_name is omitted, the widget will be shown without a title.", 
      "maxLength": 255, 
      "title": "Widget Title", 
      "type": "string"
    }, 
    "drilldown_id": {
      "description": "Id of drilldown widget, if any. Id should be a valid id of an existing widget. A widget is considered as drilldown widget when it is associated with any other widget and provides more detailed information about any data item from the parent widget.", 
      "maxLength": 255, 
      "title": "Id of drilldown widget", 
      "type": "string"
    }, 
    "feature_set": {
      "$ref": "FeatureSet, 
      "description": "Features required to view the widget.", 
      "title": "Features required to view the widget"
    }, 
    "filter": {
      "description": "Id of filter widget for subscription, if any. Id should be a valid id of an existing filter widget. Filter widget should be from the same view. Datasource URLs should have placeholder values equal to filter alias to accept the filter value on filter change.", 
      "title": "Id of filter widget for subscription", 
      "type": "string"
    }, 
    "filter_value_required": {
      "default": true, 
      "description": "Flag to indicate that widget will continue to work without filter value. If this flag is set to false then default_filter_value is manadatory.", 
      "title": "Flag to indicate if filter value is necessary", 
      "type": "boolean"
    }, 
    "footer": {
      "$ref": "Footer
    }, 
    "icons": {
      "description": "Icons to be applied at dashboard for widgets and UI elements.", 
      "items": {
        "$ref": "Icon
      }, 
      "title": "Icons", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "is_drilldown": {
      "default": false, 
      "description": "Set to true if this widget should be used as a drilldown.", 
      "title": "Set as a drilldown widget", 
      "type": "boolean"
    }, 
    "label": {
      "$ref": "Label, 
      "description": "Displayed at the sections, by default. It labels the entities of sections. If label is not provided, the sections are not labelled.", 
      "title": "Label of the Stats Configuration"
    }, 
    "legend": {
      "$ref": "Legend, 
      "description": "Legend to be displayed. If legend is not needed, do not include it.", 
      "title": "Legend for the widget"
    }, 
    "navigation": {
      "description": "Hyperlink of the specified UI page that provides details.", 
      "maxLength": 1024, 
      "title": "Navigation to a specified UI page", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "Supported visualization types are LabelValueConfiguration, DonutConfiguration, GridConfiguration, StatsConfiguration, MultiWidgetConfiguration, GraphConfiguration, ContainerConfiguration, CustomWidgetConfiguration and DropdownFilterWidgetConfiguration.", 
      "enum": [
        "LabelValueConfiguration", 
        "DonutConfiguration", 
        "MultiWidgetConfiguration", 
        "ContainerConfiguration", 
        "StatsConfiguration", 
        "GridConfiguration", 
        "GraphConfiguration", 
        "CustomWidgetConfiguration", 
        "DropdownFilterWidgetConfiguration"
      ], 
      "maxLength": 255, 
      "readonly": true, 
      "required": true, 
      "title": "Widget visualization type", 
      "type": "string"
    }, 
    "sections": {
      "decription": "High level logical grouping of portions or segments.", 
      "items": {
        "$ref": "DonutSection
      }, 
      "minItems": 0, 
      "title": "Sections", 
      "type": "array"
    }, 
    "shared": {
      "deprecated": true, 
      "description": "Please use the property 'shared' of View instead of this. The widgets of a shared view are visible to other users.", 
      "title": "Visiblity of widgets to other users", 
      "type": "boolean"
    }, 
    "span": {
      "description": "Represents the horizontal span of the widget / container.", 
      "maximum": 12, 
      "minimum": 1, 
      "title": "Horizontal span", 
      "type": "int"
    }, 
    "stat": {
      "$ref": "StatItem, 
      "description": "Expression that fetches statistic. It can be used to show the characteristics of entities such as Logical Switches, Firewall Rules, and so on. For example, number of logical switches and their admin states. If stat is not provided, then it will not be displayed.", 
      "title": "Expression for feching statistic of an entity"
    }, 
    "sub_type": {
      "description": "A sub-type of StatsConfiguration. If sub-type is not specified the parent type is rendered. The COMPACT sub_type, conserves the space for the widget. The statistic is placed on the right side on top of the status bar and the title of the widget is placed on the left side on the top of the status bar. The COMPACT style aligns itself horizontally as per the width of the container. If multiple widgets are placed insided the container then the widgets are placed one below the other to conserve the space.", 
      "enum": [
        "COMPACT"
      ], 
      "title": "Sub-type of the StatsConfiguration", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "weight": {
      "deprecated": true, 
      "description": "Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details.", 
      "title": "Weightage or placement of the widget or container", 
      "type": "int"
    }
  }, 
  "title": "Stats Configuration", 
  "type": "object"
}

StatusSummaryRequestParameters (type)

{
  "additionalProperties": false, 
  "id": "StatusSummaryRequestParameters", 
  "module_id": "Upgrade", 
  "properties": {
    "component_type": {
      "readonly": false, 
      "required": false, 
      "title": "Component type based on which upgrade units to be filtered", 
      "type": "string"
    }, 
    "selection_status": {
      "default": "ALL", 
      "enum": [
        "SELECTED", 
        "DESELECTED", 
        "ALL"
      ], 
      "required": false, 
      "title": "Flag to indicate whether to return status for only selected, only deselected or both type of upgrade units", 
      "type": "string"
    }, 
    "show_history": {
      "description": "Get details of the last 16 operations performed during the upgrade of a given component.", 
      "readonly": false, 
      "required": false, 
      "title": "Get upgrade activity for a given component", 
      "type": "boolean"
    }
  }, 
  "type": "object"
}

SuccessNodeSupportBundleResult (type)

{
  "additionalProperties": false, 
  "id": "SuccessNodeSupportBundleResult", 
  "properties": {
    "bundle_name": {
      "readonly": true, 
      "required": true, 
      "title": "Name of support bundle, e.g. nsx_NODETYPE_UUID_YYYYMMDD_HHMMSS.tgz", 
      "type": "string"
    }, 
    "bundle_size": {
      "readonly": true, 
      "required": true, 
      "title": "Size of support bundle in bytes", 
      "type": "integer"
    }, 
    "node_display_name": {
      "readonly": true, 
      "required": true, 
      "title": "Display name of node", 
      "type": "string"
    }, 
    "node_id": {
      "readonly": true, 
      "required": true, 
      "title": "UUID of node", 
      "type": "string"
    }, 
    "sha256_thumbprint": {
      "readonly": true, 
      "required": true, 
      "title": "File's SHA256 thumbprint", 
      "type": "string"
    }
  }, 
  "type": "object"
}

SummaryRequest (type)

{
  "additionalProperties": false, 
  "id": "SummaryRequest", 
  "module_id": "Upgrade", 
  "properties": {
    "summary": {
      "default": false, 
      "readonly": false, 
      "required": false, 
      "title": "Flag indicating whether to return the summary", 
      "type": "boolean"
    }
  }, 
  "type": "object"
}

SupportBundleFileTransferAuthenticationScheme (type)

{
  "additionalProperties": false, 
  "id": "SupportBundleFileTransferAuthenticationScheme", 
  "properties": {
    "password": {
      "required": true, 
      "sensitive": true, 
      "title": "Password to authenticate with", 
      "type": "string"
    }, 
    "scheme_name": {
      "enum": [
        "PASSWORD"
      ], 
      "required": true, 
      "title": "Authentication scheme name", 
      "type": "string"
    }, 
    "username": {
      "required": true, 
      "title": "User name to authenticate with", 
      "type": "string"
    }
  }, 
  "type": "object"
}

SupportBundleFileTransferProtocol (type)

{
  "additionalProperties": false, 
  "id": "SupportBundleFileTransferProtocol", 
  "properties": {
    "authentication_scheme": {
      "$ref": "SupportBundleFileTransferAuthenticationScheme, 
      "required": true, 
      "title": "Scheme to authenticate if required"
    }, 
    "name": {
      "enum": [
        "SCP", 
        "SFTP"
      ], 
      "required": true, 
      "title": "Protocol name", 
      "type": "string"
    }, 
    "ssh_fingerprint": {
      "required": true, 
      "title": "SSH fingerprint of server", 
      "type": "string"
    }
  }, 
  "type": "object"
}

SupportBundleQueryParameter (type)

{
  "additionalProperties": false, 
  "id": "SupportBundleQueryParameter", 
  "properties": {
    "override_async_response": {
      "default": false, 
      "description": "Override an existing support bundle async response if it exists. If not set to true and an existing async response is available, the support bundle request results in 409 CONFLICT.", 
      "title": "Override any existing support bundle async response", 
      "type": "boolean"
    }, 
    "require_delete_or_override_async_response": {
      "default": false, 
      "description": "If the remote_file_server option has not been specified, save generated support bundle until a subsequent request either deletes or overrides the support bundle generated by the current request using the action=delete_async_response or override_async_response=true query parameters. Setting this property to true allows the NSX API client to re-download a support bundle if for example a previous download attempt fails.", 
      "title": "Suppress auto-deletion of generated support bundle", 
      "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", 
  "module_id": "Common", 
  "properties": {
    "scope": {
      "default": "", 
      "description": "Tag searches may optionally be restricted by scope", 
      "display": {
        "order": 1
      }, 
      "maxLength": 128, 
      "readonly": false, 
      "title": "Tag scope", 
      "type": "string"
    }, 
    "tag": {
      "default": "", 
      "description": "Identifier meaningful to user with maximum length of 256 characters", 
      "display": {
        "order": 2
      }, 
      "readonly": false, 
      "title": "Tag value", 
      "type": "string"
    }
  }, 
  "title": "Arbitrary key-value pairs that may be attached to an entity", 
  "type": "object"
}

TaskProperties (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "TaskProperties", 
  "module_id": "Common", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "async_response_available": {
      "display": {
        "order": 13
      }, 
      "readonly": true, 
      "title": "True if response for asynchronous request is available", 
      "type": "boolean"
    }, 
    "cancelable": {
      "display": {
        "order": 8
      }, 
      "readonly": true, 
      "title": "True if this task can be canceled", 
      "type": "boolean"
    }, 
    "description": {
      "display": {
        "order": 2
      }, 
      "readonly": true, 
      "title": "Description of the task", 
      "type": "string"
    }, 
    "end_time": {
      "$ref": "EpochMsTimestamp, 
      "display": {
        "order": 6
      }, 
      "readonly": true, 
      "title": "The end time of the task in epoch milliseconds"
    }, 
    "id": {
      "display": {
        "order": 1
      }, 
      "readonly": true, 
      "title": "Identifier for this task", 
      "type": "string"
    }, 
    "message": {
      "display": {
        "order": 4
      }, 
      "readonly": true, 
      "title": "A message describing the disposition of the task", 
      "type": "string"
    }, 
    "progress": {
      "display": {
        "order": 7
      }, 
      "maximum": 100, 
      "minimum": 0, 
      "readonly": true, 
      "title": "Task progress if known, from 0 to 100", 
      "type": "integer"
    }, 
    "request_method": {
      "display": {
        "order": 12
      }, 
      "readonly": true, 
      "title": "HTTP request method", 
      "type": "string"
    }, 
    "request_uri": {
      "display": {
        "order": 11
      }, 
      "readonly": true, 
      "title": "URI of the method invocation that spawned this task", 
      "type": "string"
    }, 
    "start_time": {
      "$ref": "EpochMsTimestamp, 
      "display": {
        "order": 5
      }, 
      "readonly": true, 
      "title": "The start time of the task in epoch milliseconds"
    }, 
    "status": {
      "$ref": "TaskStatus, 
      "display": {
        "order": 3
      }, 
      "readonly": true, 
      "title": "Current status of the task"
    }, 
    "user": {
      "display": {
        "order": 10
      }, 
      "readonly": true, 
      "title": "Name of the user who created this task", 
      "type": "string"
    }
  }, 
  "title": "Task properties", 
  "type": "object"
}

TaskStatus (type)

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

TcpHeader (type)

{
  "additionalProperties": false, 
  "id": "TcpHeader", 
  "module_id": "Traceflow", 
  "properties": {
    "dst_port": {
      "maximum": 65535, 
      "minimum": 0, 
      "required": false, 
      "title": "Destination port of tcp header", 
      "type": "integer"
    }, 
    "src_port": {
      "maximum": 65535, 
      "minimum": 0, 
      "required": false, 
      "title": "Source port of tcp header", 
      "type": "integer"
    }, 
    "tcp_flags": {
      "maximum": 511, 
      "minimum": 0, 
      "required": false, 
      "title": "TCP flags (9bits)", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

TcpMaximumSegmentSizeClamping (type)

{
  "additionalProperties": false, 
  "description": "TCP MSS Clamping Direction and Value.", 
  "id": "TcpMaximumSegmentSizeClamping", 
  "module_id": "PolicyIPSecVpn", 
  "properties": {
    "direction": {
      "default": "NONE", 
      "description": "Specifies the traffic direction for which to apply MSS Clamping.", 
      "enum": [
        "NONE", 
        "INBOUND_CONNECTION", 
        "OUTBOUND_CONNECTION", 
        "BOTH"
      ], 
      "required": false, 
      "title": "Maximum Segment Size Clamping Direction", 
      "type": "string"
    }, 
    "max_segment_size": {
      "description": "MSS defines the maximum amount of data that a host is willing to accept in a single TCP segment. This field is set in TCP header during connection establishment. To avoid packet fragmentation, you can set this field depending on uplink MTU and VPN overhead. This is an optional field and in case it is left unconfigured, best possible MSS value will be calculated based on effective mtu of uplink interface. Supported MSS range is 216 to 8960.", 
      "maximum": 8902, 
      "minimum": 108, 
      "required": false, 
      "title": "Maximum Segment Size Value", 
      "type": "integer"
    }
  }, 
  "title": "TCP MSS Clamping", 
  "type": "object"
}

TcpPolicyLbMonitorProfile (type)

{
  "additionalProperties": false, 
  "description": "Active healthchecks are disabled by default and can be enabled for a server pool by binding a health monitor to the Group through the PolicyLbRule object. This represents active health monitoring over TCP. Active healthchecks are initiated periodically, at a configurable interval, to each member of the Group. Only if a healthcheck fails consecutively for a specified number of times (fall_count) to a member will the member status be marked DOWN. Once a member is DOWN, a specified  number of consecutive successful healthchecks (rise_count) will bring  the member back to UP state. After a healthcheck is initiated, if it  does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.", 
  "extends": {
    "$ref": "PolicyLbMonitorProfile
  }, 
  "id": "TcpPolicyLbMonitorProfile", 
  "module_id": "TempPolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "TcpPolicyLbMonitorProfile"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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"
    }, 
    "fall_count": {
      "default": 3, 
      "description": "Only if a healthcheck fails consecutively for a specified number of times, given with fall_count, to a member will the member status be marked DOWN.", 
      "required": false, 
      "title": "Monitor fall count for active healthchecks", 
      "type": "integer"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "interval": {
      "default": 5, 
      "description": "Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group.", 
      "required": false, 
      "title": "Monitor interval in seconds for active healthchecks", 
      "type": "integer"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "monitor_port": {
      "description": "Typically, monitors perform healthchecks to Group members using the member IP address and pool_port. However, in some cases, customers prefer to run healthchecks against a different port than the pool member port which handles actual application traffic. In such cases, the port to run healthchecks against can be specified in the monitor_port value.", 
      "maximum": 65535, 
      "minimum": 0, 
      "required": false, 
      "title": "Monitor port for active healthchecks", 
      "type": "int"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": [
        "TcpPolicyLbMonitorProfile", 
        "UdpPolicyLbMonitorProfile", 
        "IcmpPolicyLbMonitorProfile", 
        "HttpPolicyLbMonitorProfile", 
        "HttpsPolicyLbMonitorProfile"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "rise_count": {
      "default": 3, 
      "description": "Once a member is DOWN, a specified number of consecutive successful healthchecks specified by rise_count will bring the member back to UP state.", 
      "required": false, 
      "title": "Monitor rise count for active healthchecks", 
      "type": "integer"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "timeout": {
      "default": 15, 
      "description": "Timeout specified in seconds.  After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.", 
      "required": false, 
      "title": "Monitor timeout in seconds for active healthchecks", 
      "type": "integer"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "PolicyLbMonitorProfile for active health checks over TCP", 
  "type": "object"
}

TcpPolicyLbVirtualServer (type)

{
  "additionalProperties": false, 
  "description": "Virtual server acts as a facade to an application, receives all client connections over TCP and distributes them among the backend servers.", 
  "extends": {
    "$ref": "PolicyLbVirtualServer
  }, 
  "id": "TcpPolicyLbVirtualServer", 
  "module_id": "TempPolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "TcpPolicyLbVirtualServer"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "access_log_enabled": {
      "default": false, 
      "description": "If access log is enabled, all HTTP requests sent to an L7 virtual server are logged to the access log file. Both successful requests (backend server returns 2xx) and unsuccessful requests (backend server returns 4xx or 5xx) are logged to access log, if enabled.", 
      "required": false, 
      "title": "Access log enabled setting", 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ip_address": {
      "$ref": "IPAddress, 
      "description": "Configures the IP address of the PolicyLbVirtualServer where it receives all client connections and distributes them among the backend servers.", 
      "required": true, 
      "title": "IP address of the PolicyLbVirtualServer"
    }, 
    "lb_persistence_profile": {
      "description": "Path to optional object that enables persistence on a virtual server allowing related client connections to be sent to the same backend server. Persistence is disabled by default.", 
      "required": false, 
      "title": "Persistence Profile used by PolicyLbVirtualServer", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "ports": {
      "description": "Ports contains a list of at least one port or port range such as \"80\", \"1234-1236\". Each port element in the list should be a single port or a single port range.", 
      "items": {
        "$ref": "PortElement
      }, 
      "required": true, 
      "title": "Virtual server port number(s) or port range(s)", 
      "type": "array"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "enum": [
        "TcpPolicyLbVirtualServer", 
        "UdpPolicyLbVirtualServer", 
        "HttpPolicyLbVirtualServer", 
        "HttpsPolicyLbVirtualServer", 
        "CustomPolicyLbVirtualServer"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "router_path": {
      "description": "Path to router type object that PolicyLbVirtualServer connects to. The only supported router object is Network.", 
      "required": true, 
      "title": "Path to router type object for PolicyLbVirtualServer", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "traffic_source": {
      "type": "string"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "PolicyLbVirtualServer handling connections over TCP", 
  "type": "object"
}

Tier0 (type)

{
  "additionalProperties": false, 
  "description": "Tier-0 configuration for external connectivity.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "Tier0", 
  "module_id": "PolicyConnectivity", 
  "policy_hierarchical_children": [
    "ChildCommunityList", 
    "ChildLocaleServices", 
    "ChildPolicyDnsForwarder", 
    "ChildPrefixList", 
    "ChildStaticRoutes", 
    "ChildTier0RouteMap"
  ], 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "advanced_config": {
      "$ref": "Tier0AdvancedConfig, 
      "description": "NSX specific configuration for tier-0", 
      "required": false, 
      "title": "Advanced configuration for tier-0"
    }, 
    "arp_limit": {
      "description": "Maximum number of ARP entries per transport node.", 
      "maximum": 50000, 
      "minimum": 5000, 
      "required": false, 
      "title": "ARP limit per transport node", 
      "type": "int"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "default_rule_logging": {
      "default": false, 
      "deprecated": true, 
      "description": "Indicates if logging should be enabled for the default whitelisting rule. This field is deprecated and recommended to change Rule logging field. Note that this field is not synchronized with default logging field.", 
      "required": false, 
      "title": "Enable logging for whitelisted rule", 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "dhcp_config_paths": {
      "description": "DHCP configuration for Segments connected to Tier-0. DHCP service is configured in relay mode.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 1, 
      "minItems": 0, 
      "required": false, 
      "title": "DHCP configuration for Segments connected to Tier-0", 
      "type": "array"
    }, 
    "disable_firewall": {
      "default": false, 
      "description": "Disable or enable gateway fiewall.", 
      "required": false, 
      "title": "Disable gateway firewall", 
      "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"
    }, 
    "failover_mode": {
      "default": "NON_PREEMPTIVE", 
      "description": "Determines the behavior when a Tier-0 instance in ACTIVE-STANDBY high-availability mode restarts after a failure. If set to PREEMPTIVE, the preferred node will take over, even if it causes another failure. If set to NON_PREEMPTIVE, then the instance that restarted will remain secondary. This property is not used when the ha_mode property is set to ACTIVE_ACTIVE. Only applicable when edge cluster is configured in Tier0 locale-service.", 
      "enum": [
        "PREEMPTIVE", 
        "NON_PREEMPTIVE"
      ], 
      "required": false, 
      "title": "Failover mode", 
      "type": "string"
    }, 
    "federation_config": {
      "$ref": "FederationGatewayConfig, 
      "description": "Additional config for federation.", 
      "readonly": true, 
      "title": "Federation releated config"
    }, 
    "force_whitelisting": {
      "default": false, 
      "deprecated": true, 
      "description": "This field is deprecated and recommended to change Rule action field. Note that this field is not synchronized with default rule field.", 
      "required": false, 
      "title": "Flag to add whitelisting FW rule during realization", 
      "type": "boolean"
    }, 
    "ha_mode": {
      "default": "ACTIVE_ACTIVE", 
      "description": "Specify high-availability mode for Tier-0. Default is ACTIVE_ACTIVE. When ha_mode is changed from ACTIVE_ACTIVE to ACTIVE_STANDBY, inter SR iBGP (in BGP) is disabled. Changing ha_mode from ACTIVE_STANDBY to ACTIVE_ACTIVE will enable inter SR iBGP (in BGP) and previously configured preferred edge nodes (in Tier0 locale-service) are removed.", 
      "enum": [
        "ACTIVE_ACTIVE", 
        "ACTIVE_STANDBY"
      ], 
      "required": false, 
      "title": "High-availability Mode for Tier-0", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "internal_transit_subnets": {
      "description": "Specify subnets that are used to assign addresses to logical links connecting service routers and distributed routers. Only IPv4 addresses are supported. When not specified, subnet 169.254.0.0/24 is assigned by default in ACTIVE_ACTIVE HA mode or 169.254.0.0/28 in ACTIVE_STANDBY mode.", 
      "items": {
        "format": "ip-cidr-block", 
        "type": "string"
      }, 
      "maxItems": 1, 
      "required": false, 
      "title": "Internal transit subnets in CIDR format", 
      "type": "array"
    }, 
    "intersite_config": {
      "$ref": "IntersiteGatewayConfig, 
      "description": "Inter site routing configuration when the gateway is streched.", 
      "required": false, 
      "title": "Inter site routing configuration"
    }, 
    "ipv6_profile_paths": {
      "description": "IPv6 NDRA and DAD profiles configuration on Tier0. Either or both NDRA and/or DAD profiles can be configured.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 2, 
      "minItems": 0, 
      "required": false, 
      "title": "IPv6 NDRA and DAD profiles configuration", 
      "type": "array"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "rd_admin_field": {
      "$ref": "IPAddress, 
      "description": "If you are using EVPN service, then route distinguisher administrator address should be defined if you need auto generation of route distinguisher on your VRF configuration.", 
      "required": false, 
      "title": "Route distinguisher administrator address"
    }, 
    "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "transit_subnets": {
      "description": "Specify transit subnets that are used to assign addresses to logical links connecting tier-0 and tier-1s. Both IPv4 and IPv6 addresses are supported. When not specified, subnet 100.64.0.0/16 is configured by default.", 
      "items": {
        "format": "ip-cidr-block", 
        "type": "string"
      }, 
      "required": false, 
      "title": "Transit subnets in CIDR format", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }, 
    "vrf_config": {
      "$ref": "Tier0VrfConfig, 
      "description": "VRF config, required for VRF Tier0.", 
      "required": false, 
      "title": "VRF config"
    }
  }, 
  "title": "Tier-0 configuration", 
  "type": "object"
}

Tier0AdvancedConfig (type)

{
  "additionalProperties": false, 
  "description": "NSX specific configuration for tier-0", 
  "extends": {
    "$ref": "ConnectivityAdvancedConfig
  }, 
  "id": "Tier0AdvancedConfig", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "connectivity": {
      "default": "ON", 
      "description": "Connectivity configuration to manually connect (ON) or disconnect (OFF) a Tier1 segment from corresponding Tier1 gateway. Only valid for Tier1 Segments. This property is ignored for L2 VPN extended segments when subnets property is not specified.", 
      "enum": [
        "ON", 
        "OFF"
      ], 
      "required": false, 
      "title": "Connectivity configuration", 
      "type": "string"
    }, 
    "forwarding_up_timer": {
      "default": 0, 
      "description": "Extra time in seconds the router must wait before sending the UP notification after the peer routing session is established. Default means forward immediately. VRF logical router will set it same as parent logical router.", 
      "maximum": 300, 
      "minimum": 0, 
      "required": false, 
      "title": "Forwarding up timer", 
      "type": "integer"
    }
  }, 
  "title": "Advanced configuration for tier-0", 
  "type": "object"
}

Tier0DeploymentMap (type)

{
  "additionalProperties": false, 
  "description": "Binding of Tier-0 to the enforcement point.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "Tier0DeploymentMap", 
  "module_id": "PolicyEnforcementPointManagement", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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_point": {
      "description": "Path of enforcement point on which Tier-0 shall be deployed.", 
      "required": true, 
      "title": "Absolute Path of Enforcement Point", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Tier-0 Deployment Map", 
  "type": "object"
}

Tier0DeploymentMapListRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "Tier Deployment Map list request parameters.", 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "Tier0DeploymentMapListRequestParameters", 
  "module_id": "PolicyEnforcementPointManagement", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Tier0 Deployment Map List Request Parameters", 
  "type": "object"
}

Tier0DeploymentMapListResult (type)

{
  "additionalProperties": false, 
  "description": "Paged collection of Tier-0 Deployment Map.", 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "Tier0DeploymentMapListResult", 
  "module_id": "PolicyEnforcementPointManagement", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Tier-0 Deployment Maps.", 
      "items": {
        "$ref": "Tier0DeploymentMap
      }, 
      "required": true, 
      "title": "Tier-0 Deployment Maps", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of Tier-0 Deployment Map", 
  "type": "object"
}

Tier0GatewayState (type)

{
  "additionalProperties": false, 
  "id": "Tier0GatewayState", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "auto_rds": {
      "$ref": "AutoRds, 
      "description": "Object that holds auto assigned route distingushers for this gateway.", 
      "title": "Auto assigned Route Distingushers"
    }, 
    "enforcement_point_path": {
      "description": "String Path of the enforcement point. When not specified, routes from all enforcement-points are returned.", 
      "title": "Enforcement point path", 
      "type": "string"
    }, 
    "ipv6_status": {
      "description": "IPv6 DAD status for interfaces configured on Tier0", 
      "items": {
        "$ref": "IPv6Status
      }, 
      "title": "IPv6 DAD status for Tier0 interfaces", 
      "type": "array"
    }, 
    "tier0_state": {
      "$ref": "LogicalRouterState, 
      "description": "Detailed realized state information for Tier0", 
      "title": "Tier0 state"
    }, 
    "tier0_status": {
      "$ref": "LogicalRouterStatus, 
      "description": "Detailed realized status information for Tier0", 
      "title": "Tier0 status"
    }
  }, 
  "title": "Tier0 gateway state", 
  "type": "object"
}

Tier0HaVipConfig (type)

{
  "additionalProperties": false, 
  "id": "Tier0HaVipConfig", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "enabled": {
      "default": true, 
      "required": false, 
      "title": "Flag to enable this HA VIP config.", 
      "type": "boolean"
    }, 
    "external_interface_paths": {
      "description": "Policy paths to Tier0 external interfaces which are to be paired to provide redundancy. Floating IP will be owned by one of these interfaces depending upon which edge node is Active.", 
      "items": {
        "type": "string"
      }, 
      "minItems": 2, 
      "required": true, 
      "title": "Policy paths to Tier0 external interfaces for providing redundancy", 
      "type": "array"
    }, 
    "vip_subnets": {
      "description": "Array of IP address subnets which will be used as floating IP addresses.", 
      "items": {
        "$ref": "InterfaceSubnet
      }, 
      "maxItems": 2, 
      "minItems": 1, 
      "required": true, 
      "title": "VIP floating IP address subnets", 
      "type": "array"
    }
  }, 
  "title": "Tier0 HA VIP Config", 
  "type": "object"
}

Tier0Interface (type)

{
  "additionalProperties": false, 
  "description": "Tier-0 interface configuration for external connectivity.", 
  "extends": {
    "$ref": "BaseTier0Interface
  }, 
  "id": "Tier0Interface", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "access_vlan_id": {
      "$ref": "VlanID, 
      "description": "Vlan id.", 
      "required": false, 
      "title": "Vlan id"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "edge_cluster_member_index": {
      "deprecated": true, 
      "description": "Specify association of interface with edge cluster member. This property is deprecated, use edge_path instead. When both properties are specifed, only edge_path property is used.", 
      "minimum": 0, 
      "required": false, 
      "title": "Association of interface with edge cluster member", 
      "type": "int"
    }, 
    "edge_path": {
      "description": "Policy path to edge node to handle external connectivity. Required when interface type is EXTERNAL.", 
      "required": false, 
      "title": "Policy path to edge node", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "igmp_local_join_groups": {
      "description": "IGMP local join groups configuration.", 
      "items": {
        "$ref": "IPv4Address
      }, 
      "required": false, 
      "title": "IGMP local join groups configuration", 
      "type": "array"
    }, 
    "ipv6_profile_paths": {
      "description": "Configuration IPv6 NDRA profile. Only one NDRA profile can be configured.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 1, 
      "minItems": 0, 
      "required": false, 
      "title": "IPv6 NDRA profile configuration", 
      "type": "array"
    }, 
    "ls_id": {
      "deprecated": true, 
      "description": "Specify logical switch to which tier-0 interface is connected for external access. This property is deprecated, use segment_path instead. Both properties cannot be used together.", 
      "required": false, 
      "title": "Logical switch id to attach tier-0 interface", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "mtu": {
      "description": "Maximum transmission unit (MTU) specifies the size of the largest packet that a network protocol can transmit.", 
      "minimum": 64, 
      "required": false, 
      "title": "MTU size", 
      "type": "int"
    }, 
    "multicast": {
      "$ref": "Tier0InterfacePimConfig, 
      "description": "Multicast PIM configuration.", 
      "required": false, 
      "title": "Multicast PIM configuration"
    }, 
    "ospf": {
      "$ref": "PolicyInterfaceOspfConfig, 
      "description": "OSPF configuration.", 
      "required": false, 
      "title": "OSPF configuration"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "proxy_arp_filters": {
      "description": "Array of prefix lists used to specify filtering for ARP proxy. Prefixes in this array are used to configure ARP proxy entries on Tier-0 gateway (for uplinks).", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 1, 
      "minItems": 0, 
      "required": false, 
      "title": "List of proxy Address Resolution Protocol Filters", 
      "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"
    }, 
    "segment_path": {
      "description": "Specify Segment to which this interface is connected to. Either segment_path or ls_id property is required.", 
      "required": false, 
      "title": "Segment to attach tier-0 interface", 
      "type": "string"
    }, 
    "subnets": {
      "description": "Specify IP address and network prefix for interface.", 
      "items": {
        "$ref": "InterfaceSubnet
      }, 
      "minItems": 1, 
      "required": true, 
      "title": "IP address and subnet specification for interface", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "type": {
      "default": "EXTERNAL", 
      "description": "Interface type", 
      "enum": [
        "EXTERNAL", 
        "SERVICE", 
        "LOOPBACK"
      ], 
      "required": false, 
      "title": "Interface type", 
      "type": "string"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }, 
    "urpf_mode": {
      "default": "STRICT", 
      "enum": [
        "NONE", 
        "STRICT"
      ], 
      "required": false, 
      "title": "Unicast Reverse Path Forwarding mode", 
      "type": "string"
    }
  }, 
  "title": "Tier-0 interface configuration", 
  "type": "object"
}

Tier0InterfaceListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "Tier0InterfaceListRequestParameters", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Tier-0 Interface list request parameters", 
  "type": "object"
}

Tier0InterfaceListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "Tier0InterfaceListResult", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "Tier0Interface
      }, 
      "required": true, 
      "title": "Tier-0 Interface list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged collection of Tier-0 Interfaces", 
  "type": "object"
}

Tier0InterfacePimConfig (type)

{
  "additionalProperties": false, 
  "description": "Multicast PIM configuration.", 
  "id": "Tier0InterfacePimConfig", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "enabled": {
      "default": false, 
      "description": "enable/disable PIM configuration.", 
      "title": "enable/disable PIM configuration", 
      "type": "boolean"
    }, 
    "hello_interval": {
      "default": 30, 
      "description": "PIM hello interval(seconds) at interface level.", 
      "maximum": 180, 
      "minimum": 1, 
      "required": false, 
      "title": "PIM hello interval at interface level", 
      "type": "int"
    }, 
    "hold_interval": {
      "description": "PIM hold interval(seconds) at interface level.", 
      "maximum": 630, 
      "minimum": 1, 
      "required": false, 
      "title": "PIM hold interval at interface level", 
      "type": "int"
    }
  }, 
  "title": "Multicast PIM configuration", 
  "type": "object"
}

Tier0ListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "Tier0ListRequestParameters", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Tier-0 list request parameters", 
  "type": "object"
}

Tier0ListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "Tier0ListResult", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "Tier0
      }, 
      "required": true, 
      "title": "Tier-0 list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged collection of Tier-0s", 
  "type": "object"
}

Tier0RouteMap (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "Tier0RouteMap", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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"
    }, 
    "entries": {
      "description": "Ordered list of route map entries.", 
      "items": {
        "$ref": "RouteMapEntry
      }, 
      "maxItems": 1000, 
      "minItems": 1, 
      "required": true, 
      "title": "Ordered list of route map entries", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "RouteMap for redistributing routes to BGP and other routing protocols", 
  "type": "object"
}

Tier0RouteMapListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "Tier0RouteMapListResult", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "Tier0RouteMap
      }, 
      "required": true, 
      "title": "Tier0RouteMap results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged collection of RouteMaps", 
  "type": "object"
}

Tier0RouteRedistributionConfig (type)

{
  "additionalProperties": false, 
  "id": "Tier0RouteRedistributionConfig", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "bgp_enabled": {
      "default": true, 
      "required": false, 
      "title": "Flag to enable route redistribution for BGP.", 
      "type": "boolean"
    }, 
    "ospf_enabled": {
      "default": false, 
      "required": false, 
      "title": "Flag to enable route redistribution for OSPF.", 
      "type": "boolean"
    }, 
    "redistribution_rules": {
      "default": [], 
      "description": "List of redistribution rules.", 
      "items": {
        "$ref": "Tier0RouteRedistributionRule
      }, 
      "maxItems": 5, 
      "minItems": 0, 
      "required": false, 
      "type": "array"
    }
  }, 
  "title": "Route Redistribution config", 
  "type": "object"
}

Tier0RouteRedistributionRule (type)

{
  "additionalProperties": false, 
  "id": "Tier0RouteRedistributionRule", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "destinations": {
      "description": "Each rule can have more than one destinations. If destinations not specified for a given rule, default destionation will be BGP", 
      "items": {
        "default": "BGP", 
        "enum": [
          "BGP", 
          "OSPF"
        ], 
        "type": "string"
      }, 
      "required": false, 
      "title": "List of destination for a given redistribution rule", 
      "type": "array"
    }, 
    "name": {
      "required": false, 
      "title": "Rule name", 
      "type": "string"
    }, 
    "route_map_path": {
      "description": "Route map to be associated with the redistribution rule", 
      "required": false, 
      "type": "string"
    }, 
    "route_redistribution_types": {
      "items": {
        "$ref": "Tier0RouteRedistributionTypes
      }, 
      "required": true, 
      "title": "List of redistribution types", 
      "type": "array"
    }
  }, 
  "title": "Single route redistribution rule", 
  "type": "object"
}

Tier0RouteRedistributionTypes (type)

{
  "additionalProperties": false, 
  "description": "Tier-0 route redistribution types.    TIER0_STATIC: Redistribute user added static routes.   TIER0_CONNECTED: Redistribute all subnets configured on Interfaces and   routes related to TIER0_ROUTER_LINK, TIER0_SEGMENT,   TIER0_DNS_FORWARDER_IP, TIER0_IPSEC_LOCAL_IP, TIER0_NAT types.   TIER1_STATIC: Redistribute all subnets and static routes advertised   by Tier-1s.   TIER0_EXTERNAL_INTERFACE: Redistribute external interface subnets   on Tier-0.   TIER0_LOOPBACK_INTERFACE: Redistribute loopback interface subnets   on Tier-0.   TIER0_SEGMENT: Redistribute subnets configured on Segments connected   to Tier-0.   TIER0_ROUTER_LINK: Redistribute router link port subnets on Tier-0   TIER0_SERVICE_INTERFACE: Redistribute Tier0 service interface subnets.   TIER0_DNS_FORWARDER_IP: Redistribute DNS forwarder subnets.   TIER0_IPSEC_LOCAL_IP: Redistribute IPSec subnets.   TIER0_NAT: Redistribute NAT IPs owned by Tier-0.   TIER0_EVPN_TEP_IP: Redistribute EVPN local endpoint subnets on Tier-0.   TIER1_NAT: Redistribute NAT IPs advertised by Tier-1 instances.   TIER1_LB_VIP: Redistribute LB VIP IPs advertised by Tier-1 instances.   TIER1_LB_SNAT: Redistribute LB SNAT IPs advertised by Tier-1 instances.   TIER1_DNS_FORWARDER_IP: Redistribute DNS forwarder subnets on Tier-1   instances.   TIER1_CONNECTED: Redistribute all subnets configured on Segments and   Service Interfaces.   TIER1_SERVICE_INTERFACE: Redistribute Tier1 service interface subnets.   TIER1_SEGMENT: Redistribute subnets configured on Segments connected   to Tier1.   TIER1_IPSEC_LOCAL_ENDPOINT: Redistribute IPSec VPN local-endpoint   subnets advertised by TIER1.     Route redistribution destination is BGP.", 
  "enum": [
    "TIER0_STATIC", 
    "TIER0_CONNECTED", 
    "TIER0_EXTERNAL_INTERFACE", 
    "TIER0_SEGMENT", 
    "TIER0_ROUTER_LINK", 
    "TIER0_SERVICE_INTERFACE", 
    "TIER0_LOOPBACK_INTERFACE", 
    "TIER0_DNS_FORWARDER_IP", 
    "TIER0_IPSEC_LOCAL_IP", 
    "TIER0_NAT", 
    "TIER0_EVPN_TEP_IP", 
    "TIER1_NAT", 
    "TIER1_STATIC", 
    "TIER1_LB_VIP", 
    "TIER1_LB_SNAT", 
    "TIER1_DNS_FORWARDER_IP", 
    "TIER1_CONNECTED", 
    "TIER1_SERVICE_INTERFACE", 
    "TIER1_SEGMENT", 
    "TIER1_IPSEC_LOCAL_ENDPOINT"
  ], 
  "id": "Tier0RouteRedistributionTypes", 
  "module_id": "PolicyConnectivity", 
  "title": "Tier-0 route redistribution types", 
  "type": "string"
}

Tier0StateRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "Tier0StateRequestParameters", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "enforcement_point_path": {
      "description": "String Path of the enforcement point. When not specified, routes from all enforcement-points are returned.", 
      "title": "Enforcement point path", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "interface_path": {
      "description": "String Path of interface on current Tier0 gateway for interface specified state such as IPv6 DAD state. When not specified, IPv6 NDRA state from from all interfaces is returned.", 
      "title": "Interface path for interface specific state such as IPv6 DAD state", 
      "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": "State request parameters for Tier0 gateway", 
  "type": "object"
}

Tier0VrfConfig (type)

{
  "additionalProperties": false, 
  "description": "Tier-0 vrf configuration.", 
  "id": "Tier0VrfConfig", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "evpn_l2_vni_config": {
      "$ref": "VrfEvpnL2VniConfig, 
      "description": "It is required for VRF to participate in the EVPN service in ROUTE_SERVER mode.", 
      "required": false, 
      "title": "VRF configurations required for EVPN service in ROUTE_SERVER mode."
    }, 
    "evpn_transit_vni": {
      "description": "L3 VNI associated with the VRF for overlay traffic of ethernet virtual private network (EVPN). It must be unique and available from the VNI pool defined for EVPN service. It is required for VRF to participate in the EVPN service in INLINE mode.", 
      "required": false, 
      "title": "L3 VNI associated with the VRF for overlay traffic", 
      "type": "int"
    }, 
    "route_distinguisher": {
      "description": "Route distinguisher with format in IPAddress:<number> or ASN:<number>.", 
      "required": false, 
      "title": "Route distinguisher", 
      "type": "string"
    }, 
    "route_targets": {
      "description": "Route targets.", 
      "items": {
        "$ref": "VrfRouteTargets
      }, 
      "maxItems": 1, 
      "minItems": 1, 
      "required": false, 
      "title": "Route targets", 
      "type": "array"
    }, 
    "tier0_path": {
      "description": "Default tier0 path. Cannot be modified after realization.", 
      "required": true, 
      "title": "Tier0 path", 
      "type": "string"
    }
  }, 
  "title": "Tier-0 vrf configuration", 
  "type": "object"
}

Tier1 (type)

{
  "additionalProperties": false, 
  "description": "Tier-1 instance configuration.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "Tier1", 
  "module_id": "PolicyConnectivity", 
  "policy_hierarchical_children": [
    "ChildLocaleServices", 
    "ChildPolicyDnsForwarder", 
    "ChildSegment", 
    "ChildStaticRoutes"
  ], 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "arp_limit": {
      "description": "Maximum number of ARP entries per transport node.", 
      "maximum": 50000, 
      "minimum": 5000, 
      "required": false, 
      "title": "ARP limit per transport node", 
      "type": "int"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "default_rule_logging": {
      "default": false, 
      "deprecated": true, 
      "description": "Indicates if logging should be enabled for the default whitelisting rule. This field is deprecated and recommended to change Rule logging field. Note that this field is not synchronized with default logging field.", 
      "required": false, 
      "title": "Enable logging for whitelisted rule", 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "dhcp_config_paths": {
      "description": "DHCP configuration for Segments connected to Tier-1. DHCP service is enabled in relay mode.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 1, 
      "minItems": 0, 
      "required": false, 
      "title": "DHCP configuration for Segments connected to Tier-1", 
      "type": "array"
    }, 
    "disable_firewall": {
      "default": false, 
      "description": "Disable or enable gateway fiewall.", 
      "required": false, 
      "title": "Disable gateway firewall", 
      "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"
    }, 
    "enable_standby_relocation": {
      "default": false, 
      "description": "Flag to enable standby service router relocation. Standby relocation is not enabled until edge cluster is configured for Tier1.", 
      "required": false, 
      "title": "Flag to enable standby service router relocation.", 
      "type": "boolean"
    }, 
    "failover_mode": {
      "default": "NON_PREEMPTIVE", 
      "description": "Determines the behavior when a Tier-1 instance restarts after a failure. If set to PREEMPTIVE, the preferred node will take over, even if it causes another failure. If set to NON_PREEMPTIVE, then the instance that restarted will remain secondary. Only applicable when edge cluster is configured in Tier1 locale-service.", 
      "enum": [
        "PREEMPTIVE", 
        "NON_PREEMPTIVE"
      ], 
      "required": false, 
      "title": "Failover mode", 
      "type": "string"
    }, 
    "federation_config": {
      "$ref": "FederationGatewayConfig, 
      "description": "Additional config for federation.", 
      "readonly": true, 
      "title": "Federation releated config"
    }, 
    "force_whitelisting": {
      "default": false, 
      "deprecated": true, 
      "description": "This field is deprecated and recommended to change Rule action field. Note that this field is not synchornied with default rule field.", 
      "required": false, 
      "title": "Flag to add whitelisting FW rule during realization", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "intersite_config": {
      "$ref": "IntersiteGatewayConfig, 
      "description": "Inter site routing configuration when the gateway is streched.", 
      "required": false, 
      "title": "Inter site routing configuration"
    }, 
    "ipv6_profile_paths": {
      "description": "Configuration IPv6 NDRA and DAD profiles. Either or both NDRA and/or DAD profiles can be configured.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 2, 
      "minItems": 0, 
      "required": false, 
      "title": "IPv6 NDRA and DAD profiles configuration", 
      "type": "array"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "pool_allocation": {
      "default": "ROUTING", 
      "description": "Supports edge node allocation at different sizes for routing and load balancer service to meet performance and scalability requirements.   ROUTING: Allocate edge node to provide routing services.   LB_SMALL, LB_MEDIUM, LB_LARGE, LB_XLARGE: Specify size of load balancer service that will be configured on TIER1 gateway.", 
      "enum": [
        "ROUTING", 
        "LB_SMALL", 
        "LB_MEDIUM", 
        "LB_LARGE", 
        "LB_XLARGE"
      ], 
      "required": false, 
      "title": "Edge node allocation size", 
      "type": "string"
    }, 
    "qos_profile": {
      "$ref": "GatewayQosProfileConfig, 
      "description": "QoS Profile configuration for Tier1 router link connected to Tier0 gateway.", 
      "required": false, 
      "title": "Gateway QoS Profile configuration"
    }, 
    "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"
    }, 
    "route_advertisement_rules": {
      "items": {
        "$ref": "RouteAdvertisementRule
      }, 
      "required": false, 
      "title": "Route advertisement rules and filtering", 
      "type": "array"
    }, 
    "route_advertisement_types": {
      "description": "Enable different types of route advertisements. When not specified, routes to IPSec VPN local-endpoint subnets (TIER1_IPSEC_LOCAL_ENDPOINT) are automatically advertised.", 
      "items": {
        "$ref": "Tier1RouteAdvertisentTypes
      }, 
      "required": false, 
      "title": "Enable different types of route advertisements", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "tier0_path": {
      "description": "Specify Tier-1 connectivity to Tier-0 instance.", 
      "required": false, 
      "title": "Tier-1 connectivity to Tier-0", 
      "type": "string"
    }, 
    "type": {
      "description": "Tier1 connectivity type for reference. Property value is not validated with Tier1 configuration.   ROUTED: Tier1 is connected to Tier0 gateway and routing is enabled.   ISOLATED: Tier1 is not connected to any Tier0 gateway.   NATTED: Tier1 is in ROUTED type with NAT configured locally.", 
      "enum": [
        "ROUTED", 
        "ISOLATED", 
        "NATTED"
      ], 
      "required": false, 
      "title": "Tier1 type", 
      "type": "string"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Tier-1", 
  "type": "object"
}

Tier1DeploymentMap (type)

{
  "additionalProperties": false, 
  "description": "Binding of Tier-1 to the enforcement point.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "Tier1DeploymentMap", 
  "module_id": "PolicyEnforcementPointManagement", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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_point": {
      "description": "Path of enforcement point on which Tier-1 shall be deployed.", 
      "required": true, 
      "title": "Absolute path of Enforcement Point", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Tier-1 Deployment Map", 
  "type": "object"
}

Tier1GatewayState (type)

{
  "additionalProperties": false, 
  "id": "Tier1GatewayState", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "enforcement_point_path": {
      "description": "String Path of the enforcement point. When not specified, routes from all enforcement-points are returned.", 
      "title": "Enforcement point path", 
      "type": "string"
    }, 
    "ipv6_status": {
      "description": "IPv6 DAD status for interfaces configured on Tier1", 
      "items": {
        "$ref": "IPv6Status
      }, 
      "title": "IPv6 DAD status for Tier1 interfaces", 
      "type": "array"
    }, 
    "tier1_state": {
      "$ref": "LogicalRouterState, 
      "description": "Detailed realized state information for Tier1", 
      "title": "Tier1 state"
    }, 
    "tier1_status": {
      "$ref": "LogicalRouterStatus, 
      "description": "Detailed realized status information for Tier1", 
      "title": "Tier1 status"
    }
  }, 
  "title": "Tier1 gateway state", 
  "type": "object"
}

Tier1Interface (type)

{
  "additionalProperties": false, 
  "description": "Tier-1 interface configuration for attaching services.", 
  "extends": {
    "$ref": "BaseTier0Interface
  }, 
  "id": "Tier1Interface", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ipv6_profile_paths": {
      "description": "Configrue IPv6 NDRA profile. Only one NDRA profile can be configured.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 1, 
      "minItems": 0, 
      "required": false, 
      "title": "IPv6 NDRA profile configuration", 
      "type": "array"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "mtu": {
      "description": "Maximum transmission unit (MTU) specifies the size of the largest packet that a network protocol can transmit.", 
      "minimum": 64, 
      "required": false, 
      "title": "MTU size", 
      "type": "int"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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"
    }, 
    "segment_path": {
      "description": "Policy path of Segment to which interface is connected to.", 
      "required": true, 
      "title": "Policy path of Segment to attach interface", 
      "type": "string"
    }, 
    "subnets": {
      "description": "Specify IP address and network prefix for interface.", 
      "items": {
        "$ref": "InterfaceSubnet
      }, 
      "minItems": 1, 
      "required": true, 
      "title": "IP address and subnet specification for interface", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }, 
    "urpf_mode": {
      "default": "STRICT", 
      "enum": [
        "NONE", 
        "STRICT"
      ], 
      "required": false, 
      "title": "Unicast Reverse Path Forwarding mode", 
      "type": "string"
    }
  }, 
  "title": "Tier-1 interface configuration", 
  "type": "object"
}

Tier1InterfaceListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "Tier1InterfaceListResult", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "Tier1Interface
      }, 
      "required": true, 
      "title": "Tier-1 Interface list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged collection of Tier-1 Interfaces", 
  "type": "object"
}

Tier1ListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "Tier1ListRequestParameters", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Tier-1 list request parameters", 
  "type": "object"
}

Tier1ListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "Tier1ListResult", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "Tier1
      }, 
      "required": true, 
      "title": "Tier-1 list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged collection of Tier-1 instances", 
  "type": "object"
}

Tier1RouteAdvertisentTypes (type)

{
  "additionalProperties": false, 
  "description": "Control routes advertised by Tier-1 instance.   TIER1_STATIC_ROUTES: Advertise all STATIC routes.   TIER1_CONNECTED: Advertise all subnets configured on connected   Interfaces and Segments.   TIER1_NAT: Advertise all NAT IP addresses.   TIER1_LB_VIP: Advertise all Load-balancer VIPs.   TIER1_LB_SNAT: Advertise all Loadbalancer SNAT IP addresses.   TIER1_DNS_FORWARDER_IP: Advertise DNS forwarder source and listener IPs   TIER1_IPSEC_LOCAL_ENDPOINT: Redistribute IPSec VPN local-endpoint subnets.", 
  "enum": [
    "TIER1_STATIC_ROUTES", 
    "TIER1_CONNECTED", 
    "TIER1_NAT", 
    "TIER1_LB_VIP", 
    "TIER1_LB_SNAT", 
    "TIER1_DNS_FORWARDER_IP", 
    "TIER1_IPSEC_LOCAL_ENDPOINT"
  ], 
  "id": "Tier1RouteAdvertisentTypes", 
  "module_id": "PolicyConnectivity", 
  "type": "string"
}

Tier1StateRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "Tier1StateRequestParameters", 
  "module_id": "PolicyConnectivityStatistics", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "enforcement_point_path": {
      "description": "String Path of the enforcement point. When not specified, routes from all enforcement-points are returned.", 
      "title": "Enforcement point path", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "interface_path": {
      "description": "String Path of interface on current Tier1 gateway for interface specified state such as IPv6 DAD state. When not specified, IPv6 NDRA state from from all interfaces is returned.", 
      "title": "Interface path for interface specific state such as IPv6 DAD state", 
      "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": "State request parameters for Tier1 gateway", 
  "type": "object"
}

TlsCertificate (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "TlsCertificate", 
  "module_id": "PolicyCertificate", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "details": {
      "description": "list of X509Certificates.", 
      "items": {
        "$ref": "X509Certificate
      }, 
      "readonly": true, 
      "required": false, 
      "type": "array"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "pem_encoded": {
      "description": "pem encoded certificate data.", 
      "readonly": false, 
      "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": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "type": "object"
}

TlsCertificateList (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "TlsCertificateList", 
  "module_id": "PolicyCertificate", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "TlsCertificate list.", 
      "items": {
        "$ref": "TlsCertificate
      }, 
      "readonly": true, 
      "required": true, 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Certificate queries result", 
  "type": "object"
}

TlsCrl (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "TlsCrl", 
  "module_id": "PolicyCertificate", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "details": {
      "$ref": "X509Crl, 
      "description": "Details of the X509Crl object.", 
      "readonly": true, 
      "required": false, 
      "title": "Details of the X509Crl object"
    }, 
    "display_name": {
      "can_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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "pem_encoded": {
      "description": "Pem encoded crl data.", 
      "required": true, 
      "title": "Pem encoded crl data", 
      "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "type": "object"
}

TlsCrlListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "TlsCrlListResult", 
  "module_id": "PolicyCertificate", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "TlsCrl
      }, 
      "required": true, 
      "title": "TlsCrl list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of TlsCrl", 
  "type": "object"
}

TlsListenerCertificate (type)

{
  "additionalProperties": false, 
  "description": "Returns the certificate and thumbprint of a remote TLS listener, if the listener is running and accepting requests. If the certificate cannot be retrieved, the result property describes the problem.", 
  "id": "TlsListenerCertificate", 
  "module_id": "PolicySiteGM", 
  "properties": {
    "certificate": {
      "$ref": "X509Certificate, 
      "description": "The certificate of the TLS listener.", 
      "readonly": true, 
      "title": "The certificate of the TLS listener"
    }, 
    "result": {
      "description": "Result of get certificate operation.", 
      "enum": [
        "SUCCESS", 
        "CONNECTION_TIMEOUT", 
        "NO_ROUTE_TO_HOST", 
        "CONNECTION_REFUSED"
      ], 
      "title": "Result of get certificate operation", 
      "type": "string"
    }, 
    "thumbprint": {
      "description": "The SHA-256 thumbprint of the TLS listener.", 
      "readonly": true, 
      "title": "The SHA-256 thumbprint of the TLS listener", 
      "type": "string"
    }
  }, 
  "title": "Remote TLS Listener Certificate", 
  "type": "object"
}

TlsListenerEndpointAddressRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "The hostname or IP, and TCP port number of the listener to connect to.", 
  "id": "TlsListenerEndpointAddressRequestParameters", 
  "module_id": "PolicySiteGM", 
  "properties": {
    "address": {
      "description": "Host name or IP address of TLS listener.", 
      "format": "host-or-ip", 
      "required": true, 
      "title": "Host name or IP address of TLS listener", 
      "type": "string"
    }, 
    "port": {
      "description": "TCP port number of the TLS listener", 
      "maximum": 65535, 
      "minimum": 0, 
      "required": true, 
      "title": "TCP port number of the TLS listener", 
      "type": "int"
    }
  }, 
  "title": "TLS Listener Endpoint Address Request Parameters", 
  "type": "object"
}

TlsTrustData (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "TlsTrustData", 
  "module_id": "PolicyCertificate", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "key_algo": {
      "description": "Key algorithm contained in this certificate.", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "passphrase": {
      "description": "Password for private key encryption.", 
      "readonly": false, 
      "required": false, 
      "sensitive": true, 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "pem_encoded": {
      "description": "pem encoded certificate data.", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }, 
    "private_key": {
      "description": "private key data", 
      "readonly": false, 
      "required": false, 
      "sensitive": true, 
      "type": "string"
    }, 
    "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": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "type": "object"
}

TnNodeStackSpanStatus (type)

{
  "description": "List all the TNs spaned in L3PortMirrorSession mirror stack health status.", 
  "id": "TnNodeStackSpanStatus", 
  "module_id": "PortMirroring", 
  "properties": {
    "dedicated_stack_status": {
      "$ref": "MirrorStackStatusType, 
      "description": "Show the dedicated mirror stack health status, if the TN node has the mirror stack, it will show SUCCESS or it will show FAILED.", 
      "required": true, 
      "title": "Mirror stack health status"
    }, 
    "detail": {
      "description": "Give the detail info for mirror stack and vmknic health status. If the stack or vmknic is FAILED, detail info will tell user reason why the stauts is FAILED. So that user can correct their configuration.", 
      "required": true, 
      "title": "give detail info and reason about the vmknic and statck status", 
      "type": "string"
    }, 
    "last_updated_time": {
      "$ref": "EpochMsTimestamp, 
      "description": "TN miror stack status will be updated periodically, this item indicates the lastest timestamp of TN node stack status is updated.", 
      "required": true, 
      "title": "last updated time of TN node stack status"
    }, 
    "tn_node_id": {
      "description": "For L3PortMirrorSession configured mirror stack, show the TN node UUID which spaned in L3PortMirrorSession.", 
      "title": "TN node ID that configured L3PortMirrorSession mirror stack", 
      "type": "string"
    }, 
    "tn_node_name": {
      "description": "For L3PortMirrorSession configured mirror stack, show the TN node friendly name which spaned in L3PortMirrorSession.", 
      "required": true, 
      "title": "TN node name that configured L3SPAN mirror stack", 
      "type": "string"
    }, 
    "vmknic_status": {
      "$ref": "MirrorStackStatusType, 
      "description": "Show the vmknic health status, if the vmknic has been bouned to mirror stack, it will show SUCCESS or it will show FAILED.", 
      "required": true, 
      "title": "Mirror vmknic status"
    }
  }, 
  "title": "List all L3PortMirrorSession TN nodes mirror stack health status", 
  "type": "object"
}

Tooltip (type)

{
  "additionalProperties": false, 
  "description": "Tooltip to be shown while hovering over the dashboard UI element.", 
  "id": "Tooltip", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "properties": {
    "condition": {
      "description": "If the condition is met then the tooltip will be applied. If no condition is provided, then the tooltip will be applied unconditionally. Examples of expression syntax are provided under 'example_request' section of 'CreateWidgetConfiguration' API.", 
      "maxLength": 1024, 
      "title": "Expression for evaluating condition", 
      "type": "string"
    }, 
    "heading": {
      "description": "If true, displays tooltip text in bold", 
      "title": "Tooltip will be treated as header.", 
      "type": "boolean"
    }, 
    "text": {
      "description": "Text to be shown on tooltip while hovering over UI element. The text would be wrapped if it exceeds 80 chars.", 
      "maxLength": 1024, 
      "required": true, 
      "title": "Textbox shown at tooltip", 
      "type": "string"
    }
  }, 
  "title": "Tooltip", 
  "type": "object"
}

TraceflowConfig (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "TraceflowConfig", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "is_transient": {
      "default": true, 
      "description": "This field indicates if intent is transient and will be cleaned up by the system if set to true", 
      "required": false, 
      "title": "Marker to indicate if intent is transient", 
      "type": "boolean"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "packet": {
      "$ref": "PacketData, 
      "description": "Configuration of packet data", 
      "required": true, 
      "title": "Packet configuration"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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"
    }, 
    "segment_port_path": {
      "descrption": "Policy path or UUID of segment port to start traceflow from. Auto-plumbed\nports don't have corresponding policy path. Ports auto-created by\npolicy as part of connecting segment to Tier-0 or Tier-1 or DHCP\nserver cannot be used. UUID is validated for syntax only. This\nconfiguration will be cleaned up by the system after two hours of inactivity.\n", 
      "required": true, 
      "title": "Segment Port Path or UUID", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "timeout": {
      "default": 10, 
      "description": "Maximum time in seconds the management plane will wait for observation result to be sent by opsAgent.", 
      "maximum": 15, 
      "minimum": 5, 
      "required": false, 
      "title": "Timeout for traceflow observation results", 
      "type": "integer"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Traceflow configuration", 
  "type": "object"
}

TrafficRateLimits (type)

{
  "description": "Enables traffic limit for incoming/outgoing broadcast and multicast packets. Use 0 to disable rate limiting for a specific traffic type", 
  "id": "TrafficRateLimits", 
  "module_id": "PolicySegmentSecurity", 
  "properties": {
    "rx_broadcast": {
      "default": 0, 
      "description": "Incoming broadcast traffic limit in packets per second", 
      "minimum": 0, 
      "readonly": false, 
      "required": false, 
      "title": "Broadcast receive limit", 
      "type": "int"
    }, 
    "rx_multicast": {
      "default": 0, 
      "description": "Incoming multicast traffic limit in packets per second", 
      "minimum": 0, 
      "readonly": false, 
      "required": false, 
      "title": "Multicast receive limit", 
      "type": "int"
    }, 
    "tx_broadcast": {
      "default": 0, 
      "description": "Outgoing broadcast traffic limit in packets per second", 
      "minimum": 0, 
      "readonly": false, 
      "required": false, 
      "title": "Broadcast transmit limit", 
      "type": "int"
    }, 
    "tx_multicast": {
      "default": 0, 
      "description": "Outgoing multicast traffic limit in packets per second", 
      "minimum": 0, 
      "readonly": false, 
      "required": false, 
      "title": "Multicast transmit limit", 
      "type": "int"
    }
  }, 
  "title": "Rate limiting configuration", 
  "type": "object"
}

TransportInfo (type)

{
  "id": "TransportInfo", 
  "module_id": "LiveTrace", 
  "properties": {
    "dst_port": {
      "maximum": 65535, 
      "minimum": 0, 
      "required": false, 
      "title": "Destination port", 
      "type": "integer"
    }, 
    "protocol": {
      "enum": [
        "TCP", 
        "UDP", 
        "ICMPv4", 
        "ICMPv6"
      ], 
      "required": false, 
      "title": "Protocol type over IP layer", 
      "type": "string"
    }, 
    "src_port": {
      "maximum": 65535, 
      "minimum": 0, 
      "required": false, 
      "title": "Source port", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

TransportNodeIdParameters (type)

{
  "extends": {
    "$ref": "DataSourceParameters
  }, 
  "id": "TransportNodeIdParameters", 
  "module_id": "AggSvcL2Types", 
  "properties": {
    "source": {
      "$ref": "DataSourceType, 
      "required": false, 
      "title": "The data source, either realtime or cached. If not provided, cached data is returned."
    }, 
    "transport_node_id": {
      "required": false, 
      "title": "TransportNode Id", 
      "type": "string"
    }
  }, 
  "type": "object"
}

TransportNodeSpanEnforcedStatus (type)

{
  "additionalProperties": false, 
  "description": "Detailed Realized Status of an Intent on a span of Transport Nodes.", 
  "extends": {
    "$ref": "EnforcedStatusPerScopeNsxT
  }, 
  "id": "TransportNodeSpanEnforcedStatus", 
  "module_id": "PolicyRealizationStatus", 
  "polymorphic-type-descriptor": {
    "type-identifier": "TransportNodeSpanEnforcedStatus"
  }, 
  "properties": {
    "enforced_status_per_transport_node": {
      "description": "List of Detailed Realized Status per Transport Node.", 
      "items": {
        "$ref": "EnforcedStatusPerTransportNode
      }, 
      "readonly": true, 
      "title": "List of Enforced Realized Status per Transport Node", 
      "type": "array"
    }, 
    "resource_type": {
      "description": "Enforced Realized Status Per Scope Resource Type.", 
      "enum": [
        "TransportNodeSpanEnforcedStatus"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Resource Type", 
      "type": "string"
    }
  }, 
  "title": "Enforced Realized Status across Transport Nodes", 
  "type": "object"
}

TransportProtocolHeader (type)

{
  "additionalProperties": false, 
  "id": "TransportProtocolHeader", 
  "module_id": "Traceflow", 
  "properties": {
    "dhcp_header": {
      "$ref": "DhcpHeader, 
      "required": false, 
      "title": "DHCP header"
    }, 
    "dhcpv6_header": {
      "$ref": "Dhcpv6Header, 
      "required": false, 
      "title": "DHCP v6 header"
    }, 
    "dns_header": {
      "$ref": "DnsHeader, 
      "required": false, 
      "title": "DNS header"
    }, 
    "icmp_echo_request_header": {
      "$ref": "IcmpEchoRequestHeader, 
      "required": false, 
      "title": "ICMP echo request header"
    }, 
    "ndp_header": {
      "$ref": "NdpHeader, 
      "required": false, 
      "title": "Neighbor discovery protocol header"
    }, 
    "tcp_header": {
      "$ref": "TcpHeader, 
      "required": false, 
      "title": "TCP header"
    }, 
    "udp_header": {
      "$ref": "UdpHeader, 
      "required": false, 
      "title": "UDP header"
    }
  }, 
  "type": "object"
}

TunnelInterfaceIPSubnet (type)

{
  "additionalProperties": false, 
  "id": "TunnelInterfaceIPSubnet", 
  "module_id": "PolicyIPSecVpn", 
  "properties": {
    "ip_addresses": {
      "items": {
        "$ref": "IPv4Address
      }, 
      "maxItems": 1, 
      "minItems": 1, 
      "required": true, 
      "title": "IPv4 Addresses", 
      "type": "array"
    }, 
    "prefix_length": {
      "maximum": 31, 
      "minimum": 1, 
      "required": true, 
      "title": "Subnet Prefix Length", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

TunnelSubnet (type) (Deprecated)

{
  "additionalProperties": false, 
  "deprecated": true, 
  "id": "TunnelSubnet", 
  "module_id": "PolicyL3Vpn", 
  "properties": {
    "ip_addresses": {
      "items": {
        "$ref": "IPv4Address
      }, 
      "maxItems": 1, 
      "minItems": 1, 
      "required": true, 
      "title": "Subnet ip addresses", 
      "type": "array", 
      "uniqueItems": true
    }, 
    "prefix_length": {
      "maximum": 31, 
      "minimum": 1, 
      "required": true, 
      "title": "Subnet Prefix Length", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

UcFunctionalState (type)

{
  "additionalProperties": false, 
  "description": "Upgrade coordinator Uc functional State.", 
  "id": "UcFunctionalState", 
  "module_id": "Upgrade", 
  "properties": {
    "error_message": {
      "description": "error message that explains why UC is on standby mode.", 
      "readonly": true, 
      "required": false, 
      "title": "error message", 
      "type": "string"
    }, 
    "state": {
      "description": "function state of the upgrade coordinator", 
      "enum": [
        "RUNNING", 
        "STANDBY"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "State of UC UI", 
      "type": "string"
    }
  }, 
  "title": "Uc Functional State", 
  "type": "object"
}

UcStateProperties (type)

{
  "additionalProperties": false, 
  "id": "UcStateProperties", 
  "properties": {
    "update_uc_state_properties": {
      "default": true, 
      "required": false, 
      "title": "Flag for updating upgrade-coodinator state properties to database", 
      "type": "boolean"
    }
  }, 
  "title": "Upgrade Coordinator state properties", 
  "type": "object"
}

UcUpgradeStatus (type)

{
  "additionalProperties": false, 
  "description": "Upgrade status of upgrade-coordinator", 
  "id": "UcUpgradeStatus", 
  "module_id": "Upgrade", 
  "properties": {
    "state": {
      "description": "Current state of UC upgrade", 
      "enum": [
        "NOT_STARTED", 
        "IN_PROGRESS", 
        "SUCCESS", 
        "FAILED"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "State of UC upgrade", 
      "type": "string"
    }, 
    "status": {
      "description": "Status of UC upgrade", 
      "readonly": true, 
      "required": false, 
      "title": "Status of UC upgrade", 
      "type": "string"
    }
  }, 
  "title": "UC Upgrade status", 
  "type": "object"
}

UdpHeader (type)

{
  "additionalProperties": false, 
  "id": "UdpHeader", 
  "module_id": "Traceflow", 
  "properties": {
    "dst_port": {
      "default": 0, 
      "maximum": 65535, 
      "minimum": 0, 
      "required": false, 
      "title": "Destination port of udp header", 
      "type": "integer"
    }, 
    "src_port": {
      "default": 0, 
      "maximum": 65535, 
      "minimum": 0, 
      "required": false, 
      "title": "Source port of udp header", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

UdpPolicyLbMonitorProfile (type)

{
  "additionalProperties": false, 
  "description": "Active healthchecks are disabled by default and can be enabled for a server pool by binding a health monitor to the Group through the PolicyLbRule object. This represents active health monitoring over UDP. Active healthchecks are initiated periodically, at a configurable interval, to each member of the Group. Only if a healthcheck fails consecutively for a specified number of times (fall_count) to a member will the member status be marked DOWN. Once a member is DOWN, a specified number of consecutive successful healthchecks (rise_count) will bring the member back to UP state. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.", 
  "extends": {
    "$ref": "PolicyLbMonitorProfile
  }, 
  "id": "UdpPolicyLbMonitorProfile", 
  "module_id": "TempPolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "UdpPolicyLbMonitorProfile"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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"
    }, 
    "fall_count": {
      "default": 3, 
      "description": "Only if a healthcheck fails consecutively for a specified number of times, given with fall_count, to a member will the member status be marked DOWN.", 
      "required": false, 
      "title": "Monitor fall count for active healthchecks", 
      "type": "integer"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "interval": {
      "default": 5, 
      "description": "Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group.", 
      "required": false, 
      "title": "Monitor interval in seconds for active healthchecks", 
      "type": "integer"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "monitor_port": {
      "description": "Typically, monitors perform healthchecks to Group members using the member IP address and pool_port. However, in some cases, customers prefer to run healthchecks against a different port than the pool member port which handles actual application traffic. In such cases, the port to run healthchecks against can be specified in the monitor_port value.", 
      "maximum": 65535, 
      "minimum": 0, 
      "required": false, 
      "title": "Monitor port for active healthchecks", 
      "type": "int"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "receive": {
      "description": "Expected data, can be anywhere in the response and it has to be a string, regular expressions are not supported. UDP healthcheck is considered failed if there is no server response within the timeout period.", 
      "required": true, 
      "title": "expected data received from server", 
      "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": [
        "TcpPolicyLbMonitorProfile", 
        "UdpPolicyLbMonitorProfile", 
        "IcmpPolicyLbMonitorProfile", 
        "HttpPolicyLbMonitorProfile", 
        "HttpsPolicyLbMonitorProfile"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "rise_count": {
      "default": 3, 
      "description": "Once a member is DOWN, a specified number of consecutive successful healthchecks specified by rise_count will bring the member back to UP state.", 
      "required": false, 
      "title": "Monitor rise count for active healthchecks", 
      "type": "integer"
    }, 
    "send": {
      "description": "The data to be sent to the monitored server.", 
      "required": true, 
      "title": "data to send", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "timeout": {
      "default": 15, 
      "description": "Timeout specified in seconds.  After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.", 
      "required": false, 
      "title": "Monitor timeout in seconds for active healthchecks", 
      "type": "integer"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "PolicyLbMonitorProfile for active health checks over UDP", 
  "type": "object"
}

UdpPolicyLbVirtualServer (type)

{
  "additionalProperties": false, 
  "description": "Virtual server acts as a facade to an application, receives all client connections over UDP and distributes them among the backend servers.", 
  "extends": {
    "$ref": "PolicyLbVirtualServer
  }, 
  "id": "UdpPolicyLbVirtualServer", 
  "module_id": "TempPolicyLoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "UdpPolicyLbVirtualServer"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "access_log_enabled": {
      "default": false, 
      "description": "If access log is enabled, all HTTP requests sent to an L7 virtual server are logged to the access log file. Both successful requests (backend server returns 2xx) and unsuccessful requests (backend server returns 4xx or 5xx) are logged to access log, if enabled.", 
      "required": false, 
      "title": "Access log enabled setting", 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ip_address": {
      "$ref": "IPAddress, 
      "description": "Configures the IP address of the PolicyLbVirtualServer where it receives all client connections and distributes them among the backend servers.", 
      "required": true, 
      "title": "IP address of the PolicyLbVirtualServer"
    }, 
    "lb_persistence_profile": {
      "description": "Path to optional object that enables persistence on a virtual server allowing related client connections to be sent to the same backend server. Persistence is disabled by default.", 
      "required": false, 
      "title": "Persistence Profile used by PolicyLbVirtualServer", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "ports": {
      "description": "Ports contains a list of at least one port or port range such as \"80\", \"1234-1236\". Each port element in the list should be a single port or a single port range.", 
      "items": {
        "$ref": "PortElement
      }, 
      "required": true, 
      "title": "Virtual server port number(s) or port range(s)", 
      "type": "array"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "enum": [
        "TcpPolicyLbVirtualServer", 
        "UdpPolicyLbVirtualServer", 
        "HttpPolicyLbVirtualServer", 
        "HttpsPolicyLbVirtualServer", 
        "CustomPolicyLbVirtualServer"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "router_path": {
      "description": "Path to router type object that PolicyLbVirtualServer connects to. The only supported router object is Network.", 
      "required": true, 
      "title": "Path to router type object for PolicyLbVirtualServer", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "traffic_source": {
      "type": "string"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "PolicyLbVirtualServer handling connections over UDP", 
  "type": "object"
}

UnaryOperation (type)

{
  "additionalProperties": false, 
  "description": "Unary Operation.", 
  "id": "UnaryOperation", 
  "module_id": "PolicyReaction", 
  "properties": {
    "operand": {
      "$ref": "ResourceFieldPointer, 
      "description": "Represents an argument of the operation pointing to a specific field value.", 
      "required": true, 
      "title": "Operand"
    }, 
    "operator": {
      "description": "Logical Operator describing the operation to apply to the operand.", 
      "enum": [
        "APPEND", 
        "SUBTRACT"
      ], 
      "required": true, 
      "title": "Operator", 
      "type": "string"
    }
  }, 
  "title": "Unary Operation", 
  "type": "object"
}

UnaryOperationBasedInjectionValue (type)

{
  "additionalProperties": false, 
  "description": "Operation based Injection Value.", 
  "extends": {
    "$ref": "InjectionValue
  }, 
  "id": "UnaryOperationBasedInjectionValue", 
  "module_id": "PolicyReaction", 
  "polymorphic-type-descriptor": {
    "type-identifier": "UnaryOperationBasedInjectionValue"
  }, 
  "properties": {
    "initial_value": {
      "$ref": "ResourceFieldPointer, 
      "description": "Resource field pointer representing the initial value for the injection value. If an operation is supplied, the value is handed to the operation function to produce a final result.", 
      "required": true, 
      "title": "Intitial value"
    }, 
    "operation": {
      "$ref": "UnaryOperation, 
      "description": "Represents an optional operation to be done on the initial value.", 
      "title": "Operation Function"
    }, 
    "resource_type": {
      "description": "Injection Value resource type.", 
      "enum": [
        "UnaryOperationBasedInjectionValue"
      ], 
      "required": true, 
      "title": "Resource Type", 
      "type": "string"
    }
  }, 
  "title": "Operation based Injection Value", 
  "type": "object"
}

UnboundedKeyValuePair (type)

{
  "additionalProperties": false, 
  "id": "UnboundedKeyValuePair", 
  "module_id": "Common", 
  "properties": {
    "key": {
      "readonly": false, 
      "required": true, 
      "title": "Key", 
      "type": "string"
    }, 
    "value": {
      "readonly": false, 
      "required": true, 
      "title": "Value", 
      "type": "string"
    }
  }, 
  "title": "A key-value pair with no limitations on size", 
  "type": "object"
}

UnsupportedFeature (type)

{
  "description": "List of unsupported features for configuration onboarding on global manager.", 
  "enum": [
    "LB"
  ], 
  "id": "UnsupportedFeature", 
  "module_id": "GmConfigOnboarding", 
  "title": "Unsupported features", 
  "type": "string"
}

UpgradeBundle (type)

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

UpgradeBundleFetchRequest (type)

{
  "additionalProperties": false, 
  "description": "URL and other fetch requests of upgrade bundle", 
  "id": "UpgradeBundleFetchRequest", 
  "module_id": "Upgrade", 
  "properties": {
    "url": {
      "description": "URL for uploading upgrade bundle", 
      "readonly": false, 
      "required": true, 
      "title": "URL of upgrade bundle", 
      "type": "string"
    }
  }, 
  "title": "Fetch request for fetching upgrade bundle", 
  "type": "object"
}

UpgradeBundleId (type)

{
  "additionalProperties": false, 
  "description": "Identifier of the upgrade bundle", 
  "id": "UpgradeBundleId", 
  "module_id": "Upgrade", 
  "properties": {
    "bundle_id": {
      "description": "Identifier of bundle upload", 
      "readonly": true, 
      "required": false, 
      "title": "Bundle Id of upgrade bundle uploaded", 
      "type": "string"
    }
  }, 
  "title": "Bundle id of upgrade bundle", 
  "type": "object"
}

UpgradeBundleInfo (type)

{
  "additionalProperties": false, 
  "description": "Information about the upgrade bundle", 
  "id": "UpgradeBundleInfo", 
  "module_id": "Upgrade", 
  "properties": {
    "bundle_size": {
      "readonly": true, 
      "required": false, 
      "title": "size of upgrade bundle", 
      "type": "string"
    }, 
    "url": {
      "description": "URL for uploading upgrade bundle", 
      "readonly": true, 
      "required": false, 
      "title": "URL of the upgrade bundle", 
      "type": "string"
    }
  }, 
  "title": "Information about upgrade bundle", 
  "type": "object"
}

UpgradeBundleUploadStatus (type)

{
  "additionalProperties": false, 
  "description": "Upload status of upgrade bundle uploaded from url", 
  "id": "UpgradeBundleUploadStatus", 
  "module_id": "Upgrade", 
  "properties": {
    "detailed_status": {
      "description": "Detailed status of upgrade bundle upload", 
      "readonly": true, 
      "required": false, 
      "title": "Detailed status of bundle upload", 
      "type": "string"
    }, 
    "percent": {
      "description": "Percent of bundle uploaded from URL", 
      "readonly": true, 
      "required": false, 
      "title": "Percent of upload completed", 
      "type": "number"
    }, 
    "status": {
      "description": "Current status of upgrade bundle upload", 
      "enum": [
        "UPLOADING", 
        "VERIFYING", 
        "SUCCESS", 
        "FAILED"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Status of upgrade bundle upload", 
      "type": "string"
    }, 
    "url": {
      "description": "URL for uploading upgrade bundle", 
      "readonly": true, 
      "required": false, 
      "title": "URL from which the bundle was uploaded", 
      "type": "string"
    }
  }, 
  "title": "Upload status of upgrade bundle", 
  "type": "object"
}

UpgradeCheck (type)

{
  "additionalProperties": false, 
  "description": "Check to identify potential pre/post-upgrade issues", 
  "id": "UpgradeCheck", 
  "module_id": "Upgrade", 
  "properties": {
    "component_type": {
      "readonly": false, 
      "required": true, 
      "title": "Component type", 
      "type": "string"
    }, 
    "display_name": {
      "readonly": false, 
      "required": false, 
      "title": "Name of the pre/post-upgrade check", 
      "type": "string"
    }, 
    "failure_messages": {
      "deprecated": true, 
      "description": "List of failure messages. This field is deprecated now. Please use failures instead.", 
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "required": false, 
      "title": "List of failure messages", 
      "type": "array"
    }, 
    "failures": {
      "items": {
        "$ref": "UpgradeCheckFailureMessage
      }, 
      "readonly": true, 
      "required": false, 
      "title": "List of failures", 
      "type": "array"
    }, 
    "status": {
      "enum": [
        "SUCCESS", 
        "FAILURE", 
        "WARNING"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Status of pre/post-upgrade check", 
      "type": "string"
    }
  }, 
  "title": "Pre/post-upgrade check", 
  "type": "object"
}

UpgradeCheckCsvListResult (type)

{
  "extends": {
    "$ref": "CsvListResult
  }, 
  "id": "UpgradeCheckCsvListResult", 
  "module_id": "Upgrade", 
  "properties": {
    "file_name": {
      "description": "File name set by HTTP server if API  returns CSV result as a file.", 
      "required": false, 
      "title": "File name", 
      "type": "string"
    }, 
    "results": {
      "items": {
        "$ref": "UpgradeCheckCsvRecord
      }, 
      "required": false, 
      "type": "array"
    }
  }, 
  "type": "object"
}

UpgradeCheckCsvRecord (type)

{
  "additionalProperties": false, 
  "description": "CSV record for a pre/post-upgrade check", 
  "extends": {
    "$ref": "CsvRecord
  }, 
  "id": "UpgradeCheckCsvRecord", 
  "module_id": "Upgrade", 
  "properties": {
    "check_description": {
      "description": "Description of the pre/post-upgrade check", 
      "readonly": false, 
      "required": false, 
      "title": "Description of the upgrade check", 
      "type": "string"
    }, 
    "check_name": {
      "description": "Display name of the pre/post-upgrade check", 
      "readonly": false, 
      "required": true, 
      "title": "Name of the upgrade check", 
      "type": "string"
    }, 
    "failure_messages": {
      "description": "Space-separated list of failure messages", 
      "readonly": true, 
      "required": false, 
      "title": "Failure messages", 
      "type": "string"
    }, 
    "status": {
      "description": "Status of the pre/post-upgrade check", 
      "enum": [
        "SUCCESS", 
        "FAILURE", 
        "WARNING"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Status of the upgrade check", 
      "type": "string"
    }, 
    "upgrade_unit_id": {
      "description": "Identifier of the upgrade unit", 
      "readonly": true, 
      "required": true, 
      "title": "UUID of the upgrade unit", 
      "type": "string"
    }, 
    "upgrade_unit_metadata": {
      "description": "Meta-data of the upgrade-unit", 
      "readonly": true, 
      "required": false, 
      "title": "Meta-data of the upgrade-unit", 
      "type": "string"
    }, 
    "upgrade_unit_type": {
      "description": "Component type of the upgrade unit", 
      "readonly": false, 
      "required": true, 
      "title": "Component type", 
      "type": "string"
    }
  }, 
  "title": "CSV record for an upgrade-check", 
  "type": "object"
}

UpgradeCheckFailure (type)

{
  "additionalProperties": false, 
  "description": "Pre/post-upgrade check failure", 
  "id": "UpgradeCheckFailure", 
  "module_id": "Upgrade", 
  "properties": {
    "component_type": {
      "description": "Component type of the origin of failure", 
      "readonly": true, 
      "required": true, 
      "title": "Component type", 
      "type": "string"
    }, 
    "group_name": {
      "description": "Name of the upgrade group of the origin of failure. Only applicable when origin_type is UPGRADE_UNIT.", 
      "readonly": false, 
      "required": false, 
      "title": "Name of upgrade group", 
      "type": "string"
    }, 
    "message": {
      "$ref": "UpgradeCheckFailureMessage, 
      "description": "Pre/post-upgrade check failure message", 
      "readonly": true, 
      "required": true, 
      "title": "Upgrade check failure message"
    }, 
    "origin_id": {
      "description": "Unique id of origin of pre/post-upgrade check failure", 
      "readonly": true, 
      "required": true, 
      "title": "Unique id of origin of failure", 
      "type": "string"
    }, 
    "origin_name": {
      "description": "Name of origin of pre/post-upgrade check failure", 
      "readonly": true, 
      "required": true, 
      "title": "Name of origin of failure", 
      "type": "string"
    }, 
    "origin_type": {
      "description": "Type of origin of pre/post-upgrade check failure", 
      "enum": [
        "COMPONENT", 
        "UPGRADE_UNIT"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Type of origin of failure", 
      "type": "string"
    }, 
    "type": {
      "description": "Type of the pre/post-upgrade check failure", 
      "enum": [
        "FAILURE", 
        "WARNING"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Type of failure", 
      "type": "string"
    }
  }, 
  "title": "Upgrade check failure", 
  "type": "object"
}

UpgradeCheckFailureListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "UpgradeCheckFailureListRequestParameters", 
  "module_id": "Upgrade", 
  "properties": {
    "component_type": {
      "description": "Component type on which upgrade check failures are to be filtered", 
      "readonly": false, 
      "required": false, 
      "title": "Component type", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "filter_text": {
      "description": "Text to filter the results on. The filter text is matched with origin name and failure message. String matching for the filter is case-insensitive.", 
      "readonly": false, 
      "required": false, 
      "title": "Filter text", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "origin_type": {
      "description": "Type of origin of pre/post-upgrade check failure", 
      "enum": [
        "COMPONENT", 
        "UPGRADE_UNIT"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "Type of origin of failure", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "type": {
      "description": "Status of the pre/post-upgrade check to filter the results on", 
      "enum": [
        "FAILURE", 
        "WARNING"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "Status of the upgrade check", 
      "type": "string"
    }
  }, 
  "type": "object"
}

UpgradeCheckFailureListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "UpgradeCheckFailureListResult", 
  "module_id": "Upgrade", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "UpgradeCheckFailure
      }, 
      "required": true, 
      "title": "Collection of pre/post-upgrade check failures", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

UpgradeCheckFailureMessage (type)

{
  "description": "Pre/post-upgrade check failure message", 
  "id": "UpgradeCheckFailureMessage", 
  "module_id": "Upgrade", 
  "properties": {
    "error_code": {
      "description": "Error code for the error/warning", 
      "readonly": true, 
      "required": true, 
      "title": "Error code", 
      "type": "integer"
    }, 
    "message": {
      "description": "Error/warning message", 
      "readonly": true, 
      "required": true, 
      "title": "Error/warning message", 
      "type": "string"
    }
  }, 
  "title": "Upgrade check failure message", 
  "type": "object"
}

UpgradeCheckInfo (type)

{
  "additionalProperties": false, 
  "description": "Meta-data of a pre/post-upgrade check", 
  "id": "UpgradeCheckInfo", 
  "module_id": "Upgrade", 
  "properties": {
    "component_type": {
      "description": "Component type of the pre/post-upgrade check", 
      "readonly": false, 
      "required": true, 
      "title": "Component type", 
      "type": "string"
    }, 
    "description": {
      "description": "Description of the pre/post-upgrade check", 
      "readonly": true, 
      "required": false, 
      "title": "Description", 
      "type": "string"
    }, 
    "name": {
      "description": "Display name of the pre/post-upgrade check", 
      "readonly": true, 
      "required": true, 
      "title": "Name of the upgrade check", 
      "type": "string"
    }
  }, 
  "title": "Meta-data of a pre/post-upgrade check", 
  "type": "object"
}

UpgradeCheckInfoListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "UpgradeCheckInfoListRequestParameters", 
  "module_id": "Upgrade", 
  "properties": {
    "component_type": {
      "readonly": false, 
      "required": false, 
      "title": "Component type based on which upgrade checks are to be filtered", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

UpgradeCheckListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "UpgradeCheckListResult", 
  "module_id": "Upgrade", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "checks": {
      "items": {
        "$ref": "UpgradeCheck
      }, 
      "required": true, 
      "title": "Paged Collection of pre/post-upgrade checks", 
      "type": "array"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

UpgradeCheckListResults (type)

{
  "additionalProperties": false, 
  "id": "UpgradeCheckListResults", 
  "module_id": "Upgrade", 
  "properties": {
    "checks_with_warnings": {
      "$ref": "UpgradeCheckListResult, 
      "readonly": true, 
      "required": false
    }, 
    "failed_checks": {
      "$ref": "UpgradeCheckListResult, 
      "readonly": true, 
      "required": false
    }, 
    "successful_checks": {
      "$ref": "UpgradeCheckListResult, 
      "readonly": true, 
      "required": false
    }
  }, 
  "type": "object"
}

UpgradeChecksExecutionStatus (type)

{
  "additionalProperties": false, 
  "description": "Execution status of pre/post-upgrade checks", 
  "id": "UpgradeChecksExecutionStatus", 
  "module_id": "Upgrade", 
  "properties": {
    "details": {
      "readonly": true, 
      "required": false, 
      "title": "Details about current execution of pre/post-upgrade checks", 
      "type": "string"
    }, 
    "end_time": {
      "$ref": "EpochMsTimestamp, 
      "required": false, 
      "title": "Time (in milliseconds since epoch) when the execution of\npre/post-upgrade checks completed\n"
    }, 
    "failure_count": {
      "description": "Total count of generated failures or warnings in last execution of pre/post-upgrade checks", 
      "readonly": true, 
      "required": false, 
      "title": "Failure count", 
      "type": "int"
    }, 
    "node_with_issues_count": {
      "description": "Number of nodes which generated failures or warnings in last execution of pre/post-upgrade checks", 
      "readonly": true, 
      "required": false, 
      "title": "Number of nodes with failures/warnings", 
      "type": "int"
    }, 
    "start_time": {
      "$ref": "EpochMsTimestamp, 
      "required": false, 
      "title": "Time (in milliseconds since epoch) when the execution of\npre/post-upgrade checks started\n"
    }, 
    "status": {
      "enum": [
        "NOT_STARTED", 
        "IN_PROGRESS", 
        "ABORTING", 
        "ABORTED", 
        "COMPLETED"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Status of execution of pre/post-upgrade checks", 
      "type": "string"
    }
  }, 
  "title": "Execution status of pre/post-upgrade checks", 
  "type": "object"
}

UpgradeHistory (type)

{
  "additionalProperties": false, 
  "id": "UpgradeHistory", 
  "module_id": "UpgradeTypes", 
  "properties": {
    "initial_version": {
      "description": "Version before the upgrade started", 
      "required": true, 
      "title": "Initial Version", 
      "type": "string"
    }, 
    "target_version": {
      "description": "Version being upgraded to", 
      "required": true, 
      "title": "Target Version", 
      "type": "string"
    }, 
    "timestamp": {
      "$ref": "EpochMsTimestamp, 
      "required": true, 
      "title": "Timestamp (in milliseconds since epoch) when the upgrade was performed"
    }, 
    "upgrade_status": {
      "enum": [
        "STARTED", 
        "SUCCESS", 
        "FAILED"
      ], 
      "required": true, 
      "title": "Status of the upgrade", 
      "type": "string"
    }
  }, 
  "type": "object"
}

UpgradeHistoryList (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "UpgradeHistoryList", 
  "module_id": "UpgradeTypes", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "UpgradeHistory
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Upgrade history list", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

UpgradePlanResetRequest (type)

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

UpgradePlanSettings (type)

{
  "additionalProperties": false, 
  "id": "UpgradePlanSettings", 
  "module_id": "Upgrade", 
  "properties": {
    "parallel": {
      "default": true, 
      "readonly": false, 
      "required": false, 
      "title": "Upgrade Method to specify whether the upgrade is to be performed serially or in parallel", 
      "type": "boolean"
    }, 
    "pause_after_each_group": {
      "default": false, 
      "readonly": false, 
      "required": false, 
      "title": "Flag to indicate whether to pause the upgrade after upgrade of each group is completed", 
      "type": "boolean"
    }, 
    "pause_on_error": {
      "default": false, 
      "readonly": false, 
      "required": false, 
      "title": "Flag to indicate whether to pause the upgrade plan execution when an error occurs", 
      "type": "boolean"
    }
  }, 
  "type": "object"
}

UpgradeProgressStatus (type)

{
  "id": "UpgradeProgressStatus", 
  "properties": {
    "last_upgrade_step_status": {
      "title": "Status of last upgrade step", 
      "type": "object"
    }, 
    "upgrade_bundle_present": {
      "title": "True if upgrade bundle is present", 
      "type": "boolean"
    }, 
    "upgrade_metadata": {
      "title": "Meta info of upgrade", 
      "type": "object"
    }
  }, 
  "title": "Upgrade progress status", 
  "type": "object"
}

UpgradeStatus (type)

{
  "additionalProperties": false, 
  "id": "UpgradeStatus", 
  "module_id": "Upgrade", 
  "properties": {
    "ccp_status": {
      "$ref": "CCPUpgradeStatus, 
      "readonly": true, 
      "required": false, 
      "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": false, 
      "title": "Edge upgrade status"
    }, 
    "host_status": {
      "$ref": "HostUpgradeStatus, 
      "readonly": true, 
      "required": false, 
      "title": "Host upgrade status"
    }, 
    "overall_upgrade_status": {
      "enum": [
        "SUCCESS", 
        "FAILED", 
        "IN_PROGRESS", 
        "NOT_STARTED", 
        "PAUSING", 
        "PAUSED"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Status of upgrade", 
      "type": "string"
    }
  }, 
  "type": "object"
}

UpgradeStatusSummary (type)

{
  "id": "UpgradeStatusSummary", 
  "properties": {
    "upgrade_bundle_present": {
      "title": "True if upgrade bundle is present", 
      "type": "boolean"
    }, 
    "upgrade_metadata": {
      "title": "Meta info of upgrade", 
      "type": "object"
    }, 
    "upgrade_steps": {
      "items": {
        "type": "object"
      }, 
      "title": "List of all upgrade steps performed", 
      "type": "array"
    }
  }, 
  "title": "Upgrade status summry", 
  "type": "object"
}

UpgradeSummary (type)

{
  "additionalProperties": false, 
  "id": "UpgradeSummary", 
  "module_id": "Upgrade", 
  "properties": {
    "component_target_versions": {
      "items": {
        "$ref": "ComponentTargetVersion
      }, 
      "readonly": true, 
      "required": false, 
      "type": "array"
    }, 
    "system_version": {
      "readonly": true, 
      "required": true, 
      "title": "Current system version", 
      "type": "string"
    }, 
    "target_version": {
      "readonly": true, 
      "required": true, 
      "title": "Target system version", 
      "type": "string"
    }, 
    "upgrade_bundle_file_name": {
      "readonly": true, 
      "required": false, 
      "title": "Name of the last successfully uploaded upgrade bundle file", 
      "type": "string"
    }, 
    "upgrade_coordinator_updated": {
      "readonly": true, 
      "required": false, 
      "title": "Has upgrade coordinator been updated after upload of upgrade bundle file", 
      "type": "boolean"
    }, 
    "upgrade_coordinator_version": {
      "readonly": true, 
      "required": true, 
      "title": "Current version of upgrade coordinator", 
      "type": "string"
    }, 
    "upgrade_status": {
      "enum": [
        "SUCCESS", 
        "FAILED", 
        "IN_PROGRESS", 
        "NOT_STARTED", 
        "PAUSING", 
        "PAUSED"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Status of upgrade", 
      "type": "string"
    }
  }, 
  "type": "object"
}

UpgradeTaskProperties (type)

{
  "additionalProperties": false, 
  "id": "UpgradeTaskProperties", 
  "properties": {
    "bundle_name": {
      "required": true, 
      "title": "Name of Bundle", 
      "type": "string"
    }, 
    "parameters": {
      "readonly": true, 
      "required": false, 
      "title": "Bundle arguments", 
      "type": "object"
    }, 
    "step": {
      "required": false, 
      "title": "Step name", 
      "type": "string"
    }
  }, 
  "title": "Task properties", 
  "type": "object"
}

UpgradeTaskStatusQueryParameters (type)

{
  "id": "UpgradeTaskStatusQueryParameters", 
  "properties": {
    "bundle_name": {
      "description": "Provide a bundle name", 
      "pattern": "^[a-zA-Z0-9-.]+$", 
      "title": "Bundle Name", 
      "type": "string"
    }, 
    "upgrade_task_id": {
      "description": "Provide a task id", 
      "pattern": "^[a-z0-9-]+$", 
      "title": "Upgrade Task ID", 
      "type": "string"
    }
  }, 
  "type": "object"
}

UpgradeUnit (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "UpgradeUnit", 
  "module_id": "Upgrade", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "current_version": {
      "description": "This is component version e.g. if upgrade unit is of type edge, then this is edge version.", 
      "readonly": true, 
      "required": false, 
      "title": "Current version of upgrade unit", 
      "type": "string"
    }, 
    "display_name": {
      "readonly": false, 
      "required": false, 
      "title": "Name of the upgrade unit", 
      "type": "string"
    }, 
    "group": {
      "$ref": "UpgradeUnitGroupInfo, 
      "readonly": true, 
      "required": false, 
      "title": "Info of the group to which this upgrade unit belongs"
    }, 
    "id": {
      "description": "Identifier of the upgrade unit", 
      "readonly": true, 
      "required": true, 
      "title": "UUID of the upgrade unit", 
      "type": "string"
    }, 
    "metadata": {
      "items": {
        "$ref": "KeyValuePair
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Metadata about upgrade unit", 
      "type": "array"
    }, 
    "type": {
      "readonly": false, 
      "required": false, 
      "title": "Upgrade unit type", 
      "type": "string"
    }, 
    "warnings": {
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "required": false, 
      "title": "List of warnings indicating issues with the upgrade unit that may result in upgrade failure", 
      "type": "array"
    }
  }, 
  "type": "object"
}

UpgradeUnitAggregateInfo (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "UpgradeUnitAggregateInfo", 
  "module_id": "Upgrade", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "current_version": {
      "description": "This is component version e.g. if upgrade unit is of type edge, then this is edge version.", 
      "readonly": true, 
      "required": false, 
      "title": "Current version of upgrade unit", 
      "type": "string"
    }, 
    "display_name": {
      "readonly": false, 
      "required": false, 
      "title": "Name of the upgrade unit", 
      "type": "string"
    }, 
    "errors": {
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "required": false, 
      "title": "List of errors occurred during upgrade of this upgrade unit", 
      "type": "array"
    }, 
    "group": {
      "$ref": "UpgradeUnitGroupInfo, 
      "readonly": true, 
      "required": false, 
      "title": "Info of the group to which this upgrade unit belongs"
    }, 
    "id": {
      "description": "Identifier of the upgrade unit", 
      "readonly": true, 
      "required": true, 
      "title": "Identifier of the upgrade unit", 
      "type": "string"
    }, 
    "metadata": {
      "items": {
        "$ref": "KeyValuePair
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Metadata about upgrade unit", 
      "type": "array"
    }, 
    "percent_complete": {
      "readonly": true, 
      "required": true, 
      "title": "Indicator of upgrade progress in percentage", 
      "type": "number"
    }, 
    "post_upgrade_checks": {
      "$ref": "UpgradeCheckListResults, 
      "readonly": true, 
      "required": false
    }, 
    "pre_upgrade_checks": {
      "$ref": "UpgradeCheckListResults, 
      "readonly": true, 
      "required": false
    }, 
    "status": {
      "enum": [
        "SUCCESS", 
        "FAILED", 
        "IN_PROGRESS", 
        "NOT_STARTED", 
        "PAUSING", 
        "PAUSED"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Status of upgrade unit", 
      "type": "string"
    }, 
    "type": {
      "readonly": false, 
      "required": false, 
      "title": "Upgrade unit type", 
      "type": "string"
    }, 
    "warnings": {
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "required": false, 
      "title": "List of warnings indicating issues with the upgrade unit that may result in upgrade failure", 
      "type": "array"
    }
  }, 
  "type": "object"
}

UpgradeUnitAggregateInfoListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "UpgradeUnitAggregateInfoListRequestParameters", 
  "module_id": "Upgrade", 
  "properties": {
    "component_type": {
      "readonly": false, 
      "required": false, 
      "title": "Component type based on which upgrade units to be filtered", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "group_id": {
      "readonly": false, 
      "required": false, 
      "title": "Identifier of group based on which upgrade units to be filtered", 
      "type": "string"
    }, 
    "has_errors": {
      "default": false, 
      "readonly": false, 
      "required": false, 
      "title": "Flag to indicate whether to return only upgrade units with errors", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "metadata": {
      "readonly": false, 
      "required": false, 
      "title": "Metadata about upgrade unit to filter on", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "selection_status": {
      "default": "ALL", 
      "enum": [
        "SELECTED", 
        "DESELECTED", 
        "ALL"
      ], 
      "required": false, 
      "title": "Flag to indicate whether to return only selected, only deselected or both type of upgrade units", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "upgrade_unit_display_name": {
      "description": "Display name of upgrade unit to filter the results on. String matching for the filter is case-insensitive.", 
      "readonly": false, 
      "required": false, 
      "title": "Display name of upgrade unit", 
      "type": "string"
    }
  }, 
  "type": "object"
}

UpgradeUnitAggregateInfoListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "UpgradeUnitAggregateInfoListResult", 
  "module_id": "Upgrade", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "UpgradeUnitAggregateInfo
      }, 
      "readonly": true, 
      "required": true, 
      "title": "Paged collection of UpgradeUnit AggregateInfo", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

UpgradeUnitGroup (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "UpgradeUnitGroup", 
  "module_id": "Upgrade", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "enabled": {
      "default": true, 
      "readonly": false, 
      "required": false, 
      "title": "Flag to indicate whether upgrade of this group is enabled or not", 
      "type": "boolean"
    }, 
    "extended_configuration": {
      "items": {
        "$ref": "KeyValuePair
      }, 
      "maxItems": 100, 
      "readonly": false, 
      "required": false, 
      "title": "Extended configuration for the group", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "parallel": {
      "default": true, 
      "readonly": false, 
      "required": false, 
      "title": "Upgrade method to specify whether the upgrade is to be performed in parallel or serially", 
      "type": "boolean"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "type": {
      "readonly": false, 
      "required": true, 
      "title": "Component type", 
      "type": "string"
    }, 
    "upgrade_unit_count": {
      "description": "Number of upgrade units in the group", 
      "readonly": true, 
      "required": false, 
      "title": "Count of upgrade units in the group", 
      "type": "int"
    }, 
    "upgrade_units": {
      "items": {
        "$ref": "UpgradeUnit
      }, 
      "maxItems": 100, 
      "readonly": false, 
      "required": false, 
      "title": "List of upgrade units in the group", 
      "type": "array"
    }
  }, 
  "type": "object"
}

UpgradeUnitGroupAggregateInfo (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "UpgradeUnitGroupAggregateInfo", 
  "module_id": "Upgrade", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "enabled": {
      "default": true, 
      "readonly": false, 
      "required": false, 
      "title": "Flag to indicate whether upgrade of this group is enabled or not", 
      "type": "boolean"
    }, 
    "extended_configuration": {
      "items": {
        "$ref": "KeyValuePair
      }, 
      "maxItems": 100, 
      "readonly": false, 
      "required": false, 
      "title": "Extended configuration for the group", 
      "type": "array"
    }, 
    "failed_count": {
      "readonly": true, 
      "required": false, 
      "title": "Number of nodes in the upgrade unit group that failed upgrade", 
      "type": "int"
    }, 
    "group_level_failure": {
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Reports failures that occured at the group or cluster level.", 
      "type": "array"
    }, 
    "id": {
      "can_sort": 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"
    }, 
    "post_upgrade_status": {
      "$ref": "UpgradeChecksExecutionStatus, 
      "readonly": true, 
      "required": false, 
      "title": "Post-upgrade status of group"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "status": {
      "enum": [
        "SUCCESS", 
        "FAILED", 
        "IN_PROGRESS", 
        "NOT_STARTED", 
        "PAUSING", 
        "PAUSED"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Upgrade status of upgrade unit group", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "type": {
      "readonly": false, 
      "required": true, 
      "title": "Component type", 
      "type": "string"
    }, 
    "upgrade_unit_count": {
      "description": "Number of upgrade units in the group", 
      "readonly": true, 
      "required": false, 
      "title": "Count of upgrade units in the group", 
      "type": "int"
    }, 
    "upgrade_units": {
      "items": {
        "$ref": "UpgradeUnit
      }, 
      "maxItems": 100, 
      "readonly": false, 
      "required": false, 
      "title": "List of upgrade units in the group", 
      "type": "array"
    }
  }, 
  "type": "object"
}

UpgradeUnitGroupAggregateInfoListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "UpgradeUnitGroupAggregateInfoListResult", 
  "module_id": "Upgrade", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "UpgradeUnitGroupAggregateInfo
      }, 
      "readonly": true, 
      "required": true, 
      "title": "Paged collection of upgrade status for upgrade unit groups", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

UpgradeUnitGroupInfo (type)

{
  "additionalProperties": false, 
  "id": "UpgradeUnitGroupInfo", 
  "module_id": "Upgrade", 
  "properties": {
    "display_name": {
      "readonly": true, 
      "required": true, 
      "title": "Name of the group", 
      "type": "string"
    }, 
    "id": {
      "description": "Identifier of group", 
      "readonly": true, 
      "required": true, 
      "title": "UUID of group", 
      "type": "string"
    }
  }, 
  "type": "object"
}

UpgradeUnitGroupListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "UpgradeUnitGroupListRequestParameters", 
  "module_id": "Upgrade", 
  "properties": {
    "component_type": {
      "readonly": false, 
      "required": false, 
      "title": "Component type based on which upgrade unit groups to be filtered", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "summary": {
      "default": false, 
      "readonly": false, 
      "required": false, 
      "title": "Flag indicating whether to return summary", 
      "type": "boolean"
    }, 
    "sync": {
      "default": false, 
      "description": "If true, synchronize with the management plane before returning upgrade unit groups", 
      "required": false, 
      "title": "Synchronize before returning upgrade unit groups", 
      "type": "boolean"
    }
  }, 
  "type": "object"
}

UpgradeUnitGroupListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "UpgradeUnitGroupListResult", 
  "module_id": "Upgrade", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "UpgradeUnitGroup
      }, 
      "required": true, 
      "title": "Paged Collection of Upgrade unit groups", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

UpgradeUnitGroupStatus (type)

{
  "additionalProperties": false, 
  "id": "UpgradeUnitGroupStatus", 
  "module_id": "Upgrade", 
  "properties": {
    "failed_count": {
      "readonly": true, 
      "required": false, 
      "title": "Number of nodes in the upgrade unit group that failed upgrade", 
      "type": "int"
    }, 
    "group_id": {
      "description": "Identifier for upgrade unit group", 
      "readonly": true, 
      "required": true, 
      "title": "UUID of upgrade unit group", 
      "type": "string"
    }, 
    "group_name": {
      "description": "Name of the upgrade unit group", 
      "readonly": true, 
      "required": true, 
      "title": "Upgrade unit group Name", 
      "type": "string"
    }, 
    "percent_complete": {
      "readonly": true, 
      "required": true, 
      "title": "Indicator of upgrade progress in percentage", 
      "type": "number"
    }, 
    "status": {
      "enum": [
        "SUCCESS", 
        "FAILED", 
        "IN_PROGRESS", 
        "NOT_STARTED", 
        "PAUSING", 
        "PAUSED"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Upgrade status of upgrade unit group", 
      "type": "string"
    }, 
    "upgrade_unit_count": {
      "readonly": true, 
      "required": true, 
      "title": "Number of upgrade units in the group", 
      "type": "int"
    }
  }, 
  "type": "object"
}

UpgradeUnitGroupStatusListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "UpgradeUnitGroupStatusListResult", 
  "module_id": "Upgrade", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "UpgradeUnitGroupStatus
      }, 
      "readonly": true, 
      "required": true, 
      "title": "Paged collection of upgrade status for upgrade unit groups", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

UpgradeUnitList (type)

{
  "additionalProperties": false, 
  "id": "UpgradeUnitList", 
  "module_id": "Upgrade", 
  "properties": {
    "list": {
      "items": {
        "$ref": "UpgradeUnit
      }, 
      "required": true, 
      "title": "Collection of Upgrade units", 
      "type": "array"
    }
  }, 
  "type": "object"
}

UpgradeUnitListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "UpgradeUnitListRequestParameters", 
  "module_id": "Upgrade", 
  "properties": {
    "component_type": {
      "readonly": false, 
      "required": false, 
      "title": "Component type based on which upgrade units to be filtered", 
      "type": "string"
    }, 
    "current_version": {
      "readonly": false, 
      "required": false, 
      "title": "Current version of upgrade unit based on which upgrade units to be filtered", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "group_id": {
      "readonly": false, 
      "required": false, 
      "title": "UUID of group based on which upgrade units to be filtered", 
      "type": "string"
    }, 
    "has_warnings": {
      "default": false, 
      "readonly": false, 
      "required": false, 
      "title": "Flag to indicate whether to return only upgrade units with warnings", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "metadata": {
      "readonly": false, 
      "required": false, 
      "title": "Metadata about upgrade unit to filter on", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "upgrade_unit_type": {
      "readonly": false, 
      "required": false, 
      "title": "Upgrade unit type based on which upgrade units to be filtered", 
      "type": "string"
    }
  }, 
  "type": "object"
}

UpgradeUnitListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "UpgradeUnitListResult", 
  "module_id": "Upgrade", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "UpgradeUnit
      }, 
      "required": true, 
      "title": "Paged Collection of Upgrade units", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

UpgradeUnitStatus (type)

{
  "additionalProperties": false, 
  "id": "UpgradeUnitStatus", 
  "module_id": "Upgrade", 
  "properties": {
    "display_name": {
      "readonly": true, 
      "required": true, 
      "title": "Name of upgrade unit", 
      "type": "string"
    }, 
    "errors": {
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "required": false, 
      "title": "List of errors occurred during upgrade of this upgrade unit", 
      "type": "array"
    }, 
    "id": {
      "description": "Identifier of upgrade unit", 
      "readonly": true, 
      "required": true, 
      "title": "UUID of upgrade unit", 
      "type": "string"
    }, 
    "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", 
        "PAUSING", 
        "PAUSED"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Status of upgrade unit", 
      "type": "string"
    }
  }, 
  "type": "object"
}

UpgradeUnitStatusListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "UpgradeUnitStatusListResult", 
  "module_id": "Upgrade", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "UpgradeUnitStatus
      }, 
      "required": true, 
      "title": "Paged Collection of upgrade units status", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

UpgradeUnitTypeStats (type)

{
  "additionalProperties": false, 
  "id": "UpgradeUnitTypeStats", 
  "module_id": "Upgrade", 
  "properties": {
    "node_count": {
      "readonly": true, 
      "required": true, 
      "title": "Number of nodes", 
      "type": "int"
    }, 
    "node_with_issues_count": {
      "readonly": true, 
      "required": false, 
      "title": "Number of nodes with issues that may cause upgrade failure", 
      "type": "int"
    }, 
    "type": {
      "readonly": true, 
      "required": true, 
      "title": "Type of upgrade unit", 
      "type": "string"
    }, 
    "version": {
      "readonly": true, 
      "required": true, 
      "title": "Version of the upgrade unit", 
      "type": "string"
    }
  }, 
  "type": "object"
}

UpgradeUnitTypeStatsList (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "UpgradeUnitTypeStatsList", 
  "module_id": "Upgrade", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "UpgradeUnitTypeStats
      }, 
      "readonly": true, 
      "required": false, 
      "title": "List of upgrade unit type stats", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

UpgradeUnitsStatsRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "UpgradeUnitsStatsRequestParameters", 
  "module_id": "Upgrade", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "sync": {
      "default": false, 
      "description": "If true, synchronize with the management plane before returning upgrade unit stats", 
      "required": false, 
      "title": "Synchronize before returning upgrade unit stats", 
      "type": "boolean"
    }
  }, 
  "type": "object"
}

UrlAlias (type)

{
  "additionalProperties": false, 
  "description": "Short name or alias of a url. It is used to represent the url.", 
  "id": "UrlAlias", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "properties": {
    "alias": {
      "description": "Short name or alias of url, if any. If not specified, the url can be referenced by its index in the array of urls of the datasource instance as $<index> (for example, $0).", 
      "maxLength": 255, 
      "title": "Url Alias Name", 
      "type": "string"
    }, 
    "query": {
      "description": "Search query to be applied, if any. If query string is not provided, it will be ignored.", 
      "maxLength": 1024, 
      "title": "Search query of the search api, if any", 
      "type": "string"
    }, 
    "url": {
      "description": "Url to fetch data from.", 
      "maxLength": 1024, 
      "required": true, 
      "title": "Url", 
      "type": "string"
    }
  }, 
  "title": "Url Alias", 
  "type": "object"
}

UserInfo (type)

{
  "id": "UserInfo", 
  "module_id": "AAA", 
  "properties": {
    "roles": {
      "items": {
        "$ref": "NsxRole
      }, 
      "readonly": true, 
      "required": true, 
      "title": "Permissions", 
      "type": "array"
    }, 
    "user_name": {
      "readonly": true, 
      "required": true, 
      "title": "User Name", 
      "type": "string"
    }
  }, 
  "title": "Authenticated User Info", 
  "type": "object"
}

VIFGroupAssociationRequestParams (type)

{
  "additionalProperties": false, 
  "description": "List request parameters containing virtual network interface external ID and enforcement point path", 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "VIFGroupAssociationRequestParams", 
  "module_id": "PolicyGroupRealization", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "enforcement_point_path": {
      "description": "The path of the enforcement point from which the list of groups needs to be fetched. Forward slashes must be escaped using %2F. If no enforcement point path is specified, the default enforcement point is considered", 
      "required": false, 
      "title": "String Path of the enforcement point", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "vif_external_id": {
      "required": true, 
      "title": "Virtual network interface external ID", 
      "type": "string"
    }
  }, 
  "title": "List request parameters containing virtual network interface external ID and enforcement point path", 
  "type": "object"
}

VMGroupAssociationRequestParams (type)

{
  "additionalProperties": false, 
  "description": "List request parameters containing virtual machine external ID and enforcement point path", 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "VMGroupAssociationRequestParams", 
  "module_id": "PolicyGroupRealization", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "enforcement_point_path": {
      "description": "The path of the enforcement point from which the list of groups needs to be fetched. Forward slashes must be escaped using %2F. If no enforcement point path is specified, the default enforcement point is considered", 
      "required": false, 
      "title": "String Path of the enforcement point", 
      "type": "string"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "vm_external_id": {
      "required": true, 
      "title": "Virtual machine external ID", 
      "type": "string"
    }
  }, 
  "title": "List request parameters containing virtual machine external ID and enforcement point path", 
  "type": "object"
}

ValueConstraintExpression (type)

{
  "additionalProperties": false, 
  "description": "Represents the leaf level value constraint to constrain specified attribute value to the set of values to be allowed/not-allowed. Example - sourceGroups allowed to have only with list of groups.   {     \"operator\":\"INCLUDES\",     \"values\":[\"/infra/services/HTTP\", \"/infra/services/HTTPS\"]   }", 
  "extends": {
    "$ref": "ConstraintExpression
  }, 
  "id": "ValueConstraintExpression", 
  "module_id": "PolicyConstraints", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ValueConstraintExpression"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "operator": {
      "enum": [
        "INCLUDES", 
        "EXCLUDES", 
        "EQUALS"
      ], 
      "required": true, 
      "title": "Operation to check for value list for resource attribute of constraint.", 
      "type": "string"
    }, 
    "resource_type": {
      "enum": [
        "ValueConstraintExpression", 
        "RelatedAttributeConditionalExpression", 
        "EntityInstanceCountConstraintExpression", 
        "FieldSanityConstraintExpression"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "values": {
      "description": "List of values.", 
      "items": {
        "type": "string"
      }, 
      "required": true, 
      "title": "Array of values to perform operation.", 
      "type": "array"
    }
  }, 
  "title": "Represents the leaf level value constraint.", 
  "type": "object"
}

VersionList (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "VersionList", 
  "module_id": "VersionWhitelist", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "acceptable_versions": {
      "items": {
        "type": "string"
      }, 
      "required": true, 
      "title": "List of component versions", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

VidmInfo (type)

{
  "id": "VidmInfo", 
  "module_id": "AAA", 
  "properties": {
    "display_name": {
      "readonly": true, 
      "required": true, 
      "title": "User's Full Name Or User Group's Display Name", 
      "type": "string"
    }, 
    "name": {
      "readonly": true, 
      "required": true, 
      "title": "Username Or Groupname", 
      "type": "string"
    }, 
    "type": {
      "enum": [
        "remote_user", 
        "remote_group"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Type", 
      "type": "string"
    }
  }, 
  "title": "Vidm Info", 
  "type": "object"
}

VidmInfoListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "VidmInfoListResult", 
  "module_id": "AAA", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "VidmInfo
      }, 
      "required": true, 
      "title": "List results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

VidmInfoSearchRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "VidmInfoSearchRequestParameters", 
  "module_id": "AAA", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "search_string": {
      "description": "This is a substring search that is case insensitive.", 
      "required": true, 
      "title": "Search string to search for.\n", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Vidm information search request parameters", 
  "type": "object"
}

View (type)

{
  "additionalProperties": false, 
  "description": "Describes the configuration of a view to be displayed on the dashboard.", 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "View", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "description": "Title of the widget.", 
      "maxLength": 255, 
      "required": true, 
      "title": "Widget Title", 
      "type": "string"
    }, 
    "exclude_roles": {
      "description": "Comma separated list of roles to which the shared view is not visible. Allows user to prevent the visibility of a shared view to the specified roles. User defined roles can also be specified in the list. The roles can be obtained via GET /api/v1/aaa/roles. Please visit API documentation for details about roles. If include_roles is specified then exclude_roles cannot be specified.", 
      "maxLength": 1024, 
      "title": "Roles to which the shared view is not visible", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "include_roles": {
      "description": "Comma separated list of roles to which the shared view is visible. Allows user to specify the visibility of a shared view to the specified roles. User defined roles can also be specified in the list. The roles can be obtained via GET /api/v1/aaa/roles. Please visit API documentation for details about roles.", 
      "maxLength": 1024, 
      "title": "Roles to which the shared view is visible", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "shared": {
      "default": false, 
      "description": "Defaults to false. Set to true to publish the view to other users. The widgets of a shared view are visible to other users.", 
      "title": "Share the view with other users", 
      "type": "boolean"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "weight": {
      "default": 10000, 
      "description": "Determines placement of view relative to other views. The lower the weight, the higher it is in the placement order.", 
      "title": "Weightage or placement of the view", 
      "type": "int"
    }, 
    "widgets": {
      "description": "Array of widgets that are part of the view.", 
      "items": {
        "$ref": "WidgetItem
      }, 
      "minItems": 0, 
      "required": true, 
      "title": "Widgets", 
      "type": "array"
    }
  }, 
  "title": "Dashboard View", 
  "type": "object"
}

ViewList (type)

{
  "additionalProperties": false, 
  "description": "Represents a list of views.", 
  "id": "ViewList", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "properties": {
    "views": {
      "description": "Array of views", 
      "items": {
        "$ref": "View
      }, 
      "readonly": true, 
      "required": true, 
      "title": "Array of views", 
      "type": "array"
    }
  }, 
  "title": "List of Views", 
  "type": "object"
}

ViewQueryParameters (type)

{
  "additionalProperties": false, 
  "id": "ViewQueryParameters", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "properties": {
    "tag": {
      "description": "The tag for which associated views to be queried. For tags specified on views, scope is automatically set to 'nsx-dashboard' and hence scope is ignored for searching views based on tag.", 
      "readonly": true, 
      "title": "The tag for which associated views to be queried.", 
      "type": "string"
    }, 
    "view_ids": {
      "description": "Comma separated ids of views to be queried.", 
      "maxLength": 8192, 
      "readonly": true, 
      "title": "Ids of the Views", 
      "type": "string"
    }, 
    "widget_id": {
      "description": "Id of widget to be queried for all the views it is part of.", 
      "maxLength": 255, 
      "readonly": true, 
      "title": "Id of widget configuration", 
      "type": "string"
    }
  }, 
  "title": "Parameters for querying views", 
  "type": "object"
}

VirtualEndpoint (type)

{
  "additionalProperties": false, 
  "description": "A VirtualEndpoint represents an IP (or nexthop) which is outside SDDC. It represents a redirection target for RedirectionPolicy.", 
  "extends": {
    "$ref": "BaseEndpoint
  }, 
  "id": "VirtualEndpoint", 
  "module_id": "PolicyServiceInsertion", 
  "polymorphic-type-descriptor": {
    "type-identifier": "VirtualEndpoint"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "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, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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": [
        "VirtualEndpoint", 
        "ServiceInstanceEndpoint"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "service_names": {
      "description": "One VirtualEndpoint will be created per service name.", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 1, 
      "minItems": 1, 
      "readonly": false, 
      "required": true, 
      "title": "Services for which this endpoint to be created", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "target_ips": {
      "description": "IPs where either inbound or outbound traffic is to be redirected.", 
      "items": {
        "$ref": "IPInfo
      }, 
      "maxItems": 1, 
      "minItems": 1, 
      "required": true, 
      "title": "IP addresses to redirect the traffic to", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "This endpoint is strictly of the type Virtual", 
  "type": "object"
}

VirtualMachine (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "DiscoveredResource
  }, 
  "id": "VirtualMachine", 
  "module_id": "Inventory", 
  "properties": {
    "_last_sync_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "compute_ids": {
      "items": {
        "type": "string"
      }, 
      "required": true, 
      "title": "List of external compute ids of the virtual machine in the format 'id-type-key:value' , list of external compute ids ['uuid:xxxx-xxxx-xxxx-xxxx', 'moIdOnHost:moref-11', 'instanceUuid:xxxx-xxxx-xxxx-xxxx']", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "external_id": {
      "required": true, 
      "title": "Current external id of this virtual machine in the system.", 
      "type": "string"
    }, 
    "guest_info": {
      "$ref": "GuestInfo, 
      "description": "Guest virtual machine details include OS name, computer name of guest VM. Currently this is supported for guests on ESXi that have VMware Tools installed.", 
      "required": false, 
      "title": "Guest virtual machine details"
    }, 
    "host_id": {
      "required": false, 
      "title": "Id of the host in which this virtual machine exists.", 
      "type": "string"
    }, 
    "local_id_on_host": {
      "required": true, 
      "title": "Id of the vm unique within the host.", 
      "type": "string"
    }, 
    "power_state": {
      "enum": [
        "VM_RUNNING", 
        "VM_STOPPED", 
        "VM_SUSPENDED", 
        "UNKNOWN"
      ], 
      "required": true, 
      "title": "Current power state of this virtual machine in the system.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }, 
    "source": {
      "$ref": "ResourceReference, 
      "required": false, 
      "title": "Reference of the Host or Public Cloud Gateway that reported the VM"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "type": {
      "enum": [
        "EDGE", 
        "SERVICE", 
        "REGULAR"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Virtual Machine type; Edge, Service VM or other.", 
      "type": "string"
    }
  }, 
  "type": "object"
}

VirtualNetworkInterface (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "DiscoveredResource
  }, 
  "id": "VirtualNetworkInterface", 
  "module_id": "Inventory", 
  "properties": {
    "_last_sync_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "device_key": {
      "required": true, 
      "title": "Device key of the virtual network interface.", 
      "type": "string"
    }, 
    "device_name": {
      "required": false, 
      "title": "Device name of the virtual network interface.", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "external_id": {
      "required": true, 
      "title": "External Id of the virtual network inferface.", 
      "type": "string"
    }, 
    "host_id": {
      "required": true, 
      "title": "Id of the host on which the vm exists.", 
      "type": "string"
    }, 
    "ip_address_info": {
      "items": {
        "$ref": "IpAddressInfo
      }, 
      "required": false, 
      "title": "IP Addresses of the the virtual network interface, from various sources.", 
      "type": "array"
    }, 
    "lport_attachment_id": {
      "required": false, 
      "title": "LPort Attachment Id of the virtual network interface.", 
      "type": "string"
    }, 
    "mac_address": {
      "required": true, 
      "title": "MAC address of the virtual network interface.", 
      "type": "string"
    }, 
    "owner_vm_id": {
      "required": true, 
      "title": "Id of the vm to which this virtual network interface belongs.", 
      "type": "string"
    }, 
    "owner_vm_type": {
      "enum": [
        "EDGE", 
        "SERVICE", 
        "REGULAR"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Owner virtual machine type; Edge, Service VM or other.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "vm_local_id_on_host": {
      "required": true, 
      "title": "Id of the vm unique within the host.", 
      "type": "string"
    }
  }, 
  "type": "object"
}

VirtualNetworkInterfaceListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult
  }, 
  "id": "VirtualNetworkInterfaceListResult", 
  "module_id": "Inventory", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "VirtualNetworkInterface
      }, 
      "required": true, 
      "title": "VirtualNetworkInterface list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

VirtualPortgroup (type)

{
  "extends": {
    "$ref": "DiscoveredResource
  }, 
  "id": "VirtualPortgroup", 
  "module_id": "InventoryCmObj", 
  "polymorphic-type-descriptor": {
    "type-identifier": "VirtualPortgroup"
  }, 
  "properties": {
    "_last_sync_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cm_local_id": {
      "description": "Id of the portgroup, eg. a mo-ref from VC.", 
      "readonly": true, 
      "required": false, 
      "title": "Id of the portgroup in compute manager", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "external_id": {
      "readonly": true, 
      "required": true, 
      "title": "External id of the virtual portgroup", 
      "type": "string"
    }, 
    "origin_type": {
      "readonly": true, 
      "required": false, 
      "title": "Portgroup type like DistributedVirtualPortgroup", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Virtual portgroup on a virtual switch", 
  "type": "object"
}

VirtualSwitch (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "DiscoveredResource
  }, 
  "id": "VirtualSwitch", 
  "module_id": "InventoryCmObj", 
  "polymorphic-type-descriptor": {
    "type-identifier": "VirtualSwitch"
  }, 
  "properties": {
    "_last_sync_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cm_local_id": {
      "readonly": true, 
      "required": false, 
      "title": "ID of the virtual switch in compute manager", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "external_id": {
      "readonly": true, 
      "required": true, 
      "title": "External id of the virtual switch", 
      "type": "string"
    }, 
    "origin_id": {
      "description": "ID of the compute manager where this virtual switch is discovered.", 
      "readonly": true, 
      "required": false, 
      "title": "ID of the compute manager", 
      "type": "string"
    }, 
    "origin_type": {
      "readonly": true, 
      "required": false, 
      "title": "Switch type like VmwareDistributedVirtualSwitch", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Virtual switch on a compute manager", 
  "type": "object"
}

VlanID (type)

{
  "id": "VlanID", 
  "maximum": 4094, 
  "minimum": 0, 
  "module_id": "Types", 
  "title": "Virtual Local Area Network Identifier", 
  "type": "integer"
}

VlanVniRangePair (type)

{
  "additionalProperties": false, 
  "description": "Vlan-Vni mapping pair resource in EvpnTenantConfig for ROUTE-SERVER Evpn mode", 
  "id": "VlanVniRangePair", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "vlans": {
      "description": "List of VLAN ids and VLAN ranges (specified with '-').", 
      "required": true, 
      "title": "List of VLAN ids", 
      "type": "string"
    }, 
    "vnis": {
      "description": "List of VNI ids and VNI ranges (specified with '-'). The vni id is used for VXLAN transmission for a given tenant Vlan ID in ROUTE-SERVER Evpn.", 
      "required": true, 
      "title": "List of VNI ids", 
      "type": "string"
    }
  }, 
  "title": "Vlan Vni pair resource", 
  "type": "object"
}

VmToolsInfo (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "DiscoveredResource
  }, 
  "id": "VmToolsInfo", 
  "module_id": "VmToolsInfo", 
  "properties": {
    "_last_sync_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "external_id": {
      "description": "Current external id of this virtual machine in the system.", 
      "readonly": true, 
      "required": false, 
      "title": "VM external ID", 
      "type": "string"
    }, 
    "file_agent_version": {
      "description": "Version of file agent on the VM of a third party partner solution.", 
      "readonly": true, 
      "required": false, 
      "title": "File agent version on the VM", 
      "type": "string"
    }, 
    "host_local_id": {
      "description": "Id of the VM which is assigned locally by the host. It is the VM-moref on ESXi hosts, in other environments it is VM UUID.", 
      "readonly": true, 
      "required": false, 
      "title": "VM ID given by the host", 
      "type": "string"
    }, 
    "network_agent_version": {
      "description": "Version of network agent on the VM of a third party partner solution.", 
      "readonly": true, 
      "required": false, 
      "title": "Network agent version on the VM", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }, 
    "source": {
      "$ref": "ResourceReference, 
      "readonly": true, 
      "required": false, 
      "title": "Reference of the Host or Public Cloud Gateway that reported the VM."
    }, 
    "svm_connectivity": {
      "description": "Endpoint Protection (Third party AV partner using NXGI) status on the VM. TRUE  - VM is configured and protected by EPP Service VM. FALSE - VM is either not configured for protection or VM is disconnected from EPP Service VM.", 
      "readonly": true, 
      "required": false, 
      "title": "Endpoint Protection status on the VM", 
      "type": "boolean"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "tools_version": {
      "description": "Version of VMTools installed on the VM.", 
      "readonly": true, 
      "required": false, 
      "title": "VM tools version on the VM", 
      "type": "string"
    }, 
    "vm_type": {
      "description": "Type of VM - Edge, Service or other.", 
      "enum": [
        "EDGE", 
        "SERVICE", 
        "REGULAR"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Virtual Machine type", 
      "type": "string"
    }
  }, 
  "type": "object"
}

VniPoolConfig (type)

{
  "additionalProperties": false, 
  "description": "Vni Pool Configuration.", 
  "extends": {
    "$ref": "PolicyConfigResource
  }, 
  "id": "VniPoolConfig", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "children": {
      "description": "subtree for this type within policy tree containing nested elements.", 
      "items": {
        "$ref": "ChildPolicyConfigResource
      }, 
      "required": false, 
      "title": "subtree for this type within policy tree", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "end": {
      "maximum": 16777215, 
      "minimum": 75001, 
      "required": true, 
      "title": "End value of VNI Pool range", 
      "type": "int"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "marked_for_delete": {
      "default": false, 
      "description": "Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether the intent object is marked for deletion", 
      "type": "boolean"
    }, 
    "overridden": {
      "default": false, 
      "description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.", 
      "readonly": true, 
      "required": false, 
      "title": "Indicates whether this object is the overridden intent object", 
      "type": "boolean"
    }, 
    "parent_path": {
      "description": "Path of its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Path of its parent", 
      "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"
    }, 
    "start": {
      "maximum": 16777215, 
      "minimum": 75001, 
      "required": true, 
      "title": "Start value of VNI Pool range", 
      "type": "int"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "unique_id": {
      "description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.", 
      "readonly": true, 
      "required": false, 
      "title": "A unique identifier assigned by the system", 
      "type": "string"
    }
  }, 
  "title": "Vni Pool Config", 
  "type": "object"
}

VrfEvpnL2VniConfig (type)

{
  "id": "VrfEvpnL2VniConfig", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "enable_vtep_groups": {
      "default": false, 
      "description": "This is used to enable or disable the creation of vtep groups. Each vtep group is used to group vteps with the same MAC for L2 ECMP usage.", 
      "required": false, 
      "title": "Flag to enable or disable the creation of vtep groups", 
      "type": "boolean"
    }, 
    "l2_vni_configs": {
      "description": "Define L2 VNI and its related route distinguiser and route targets.", 
      "items": {
        "$ref": "VrfL2VniConfig
      }, 
      "maxItems": 1, 
      "minItems": 1, 
      "required": true, 
      "title": "L2 VNI configurations associated with the VRF", 
      "type": "array"
    }
  }, 
  "type": "object"
}

VrfL2VniConfig (type)

{
  "id": "VrfL2VniConfig", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "l2_vni": {
      "description": "L2 VNI associated with the VRF. It must be unique and available from the VNI pool defined for EVPN service.", 
      "required": true, 
      "title": "L2 VNI associated with the VRF", 
      "type": "int"
    }, 
    "route_distinguisher": {
      "description": "This is a 64 bit number which disambiguates overlapping logical networks, with format in IPAddress:<number> or ASN:<number>.", 
      "required": true, 
      "title": "The unique route distinguisher for the virtual routing and forwarding instance", 
      "type": "string"
    }, 
    "route_targets": {
      "description": "Route targets.", 
      "items": {
        "$ref": "VrfRouteTargets
      }, 
      "maxItems": 1, 
      "minItems": 1, 
      "required": true, 
      "title": "Route targets", 
      "type": "array"
    }
  }, 
  "type": "object"
}

VrfRouteTargets (type)

{
  "additionalProperties": false, 
  "description": "Vrf Route Targets for import/export.", 
  "id": "VrfRouteTargets", 
  "module_id": "PolicyConnectivity", 
  "properties": {
    "address_family": {
      "default": "L2VPN_EVPN", 
      "description": "Address family.", 
      "enum": [
        "L2VPN_EVPN"
      ], 
      "required": false, 
      "title": "Address family", 
      "type": "string"
    }, 
    "export_route_targets": {
      "description": "Export route targets with format in ASN:<number>.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Export route targets", 
      "type": "array"
    }, 
    "import_route_targets": {
      "description": "Import route targets with format in ASN:<number>.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Import route targets", 
      "type": "array"
    }
  }, 
  "title": "Vrf Route Targets", 
  "type": "object"
}

VrniGlobalCollector (type)

{
  "additionalProperties": false, 
  "desceiption": "vRNI collector collects the system metrics to\nVmware vRNI (vRealize Network Insight) platform\nfor network monitoring and analytics.\n", 
  "extends": {
    "$ref": "GlobalCollectorConfig
  }, 
  "id": "VrniGlobalCollector", 
  "module_id": "Policy", 
  "polymorphic-type-descriptor": {
    "type-identifier": "VRNI"
  }, 
  "properties": {
    "collector_ip": {
      "$ref": "IPAddress, 
      "description": "IP address for the global collector.", 
      "required": true, 
      "title": "IP address for the global collector collector"
    }, 
    "collector_port": {
      "description": "Port for the global collector.", 
      "maximum": 65535, 
      "minimum": 0, 
      "required": true, 
      "title": "Port for the global collector", 
      "type": "int"
    }, 
    "collector_type": {
      "$ref": "GlobalCollectorType, 
      "description": "Specify the global collector type.", 
      "required": true
    }, 
    "report_interval": {
      "default": 30, 
      "description": "Report interval for operation data in seconds.", 
      "maximum": 1800, 
      "minimum": 1, 
      "required": true, 
      "title": "Report interval for operation data in seconds", 
      "type": "int"
    }
  }, 
  "title": "NSX global configs for VRNI global collector", 
  "type": "object"
}

WaveFrontGlobalCollector (type)

{
  "additionalProperties": false, 
  "desceiption": "Wavefront collector is defined to export the real-time\nmetrics to Vmware Warfront platform for monitoring and streaming analysis.\nIt is only appliacble on VMC mode.\n", 
  "extends": {
    "$ref": "GlobalCollectorConfig
  }, 
  "id": "WaveFrontGlobalCollector", 
  "module_id": "Policy", 
  "polymorphic-type-descriptor": {
    "type-identifier": "WAVE_FRONT"
  }, 
  "properties": {
    "collector_ip": {
      "$ref": "IPAddress, 
      "description": "IP address for the global collector.", 
      "required": true, 
      "title": "IP address for the global collector collector"
    }, 
    "collector_port": {
      "description": "Port for the global collector.", 
      "maximum": 65535, 
      "minimum": 0, 
      "required": true, 
      "title": "Port for the global collector", 
      "type": "int"
    }, 
    "collector_type": {
      "$ref": "GlobalCollectorType, 
      "description": "Specify the global collector type.", 
      "required": true
    }
  }, 
  "title": "NSX global configs for WAVE_FRONT global collector", 
  "type": "object"
}

WeeklyBackupSchedule (type)

{
  "extends": {
    "$ref": "BackupSchedule
  }, 
  "id": "WeeklyBackupSchedule", 
  "module_id": "BackupConfiguration", 
  "polymorphic-type-descriptor": {
    "type-identifier": "WeeklyBackupSchedule"
  }, 
  "properties": {
    "days_of_week": {
      "items": {
        "type": "integer"
      }, 
      "maxItems": 7, 
      "minItems": 1, 
      "required": true, 
      "title": "Days of week when backup is taken. 0 - Sunday, 1 - Monday, 2 - Tuesday, 3 - Wednesday ...", 
      "type": "array", 
      "uniqueItems": true
    }, 
    "hour_of_day": {
      "maximum": 23, 
      "minimum": 0, 
      "required": true, 
      "title": "Time of day when backup is taken", 
      "type": "integer"
    }, 
    "minute_of_day": {
      "maximum": 59, 
      "minimum": 0, 
      "required": true, 
      "title": "Time of day when backup is taken", 
      "type": "integer"
    }, 
    "resource_type": {
      "enum": [
        "WeeklyBackupSchedule", 
        "IntervalBackupSchedule"
      ], 
      "required": true, 
      "title": "Schedule type", 
      "type": "string"
    }
  }, 
  "title": "Schedule to specify day of the week and time to take automated backup", 
  "type": "object"
}

WidgetConfiguration (type)

{
  "additionalProperties": false, 
  "description": "Describes the configuration of a widget to be displayed on the dashboard. WidgetConfiguration is a base type that provides attributes of a widget in-general.", 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "WidgetConfiguration", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "polymorphic-type-descriptor": {
    "mode": "enabled"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "datasources": {
      "description": "The 'datasources' represent the sources from which data will be fetched. Currently, only NSX-API is supported as a 'default' datasource. An example of specifying 'default' datasource along with the urls to fetch data from is given at 'example_request' section of 'CreateWidgetConfiguration' API.", 
      "items": {
        "$ref": "Datasource
      }, 
      "minItems": 0, 
      "title": "Array of Datasource Instances with their relative urls", 
      "type": "array"
    }, 
    "default_filter_value": {
      "description": "Default filter values to be passed to datasources. This will be used when the report is requested without filter values.", 
      "items": {
        "$ref": "DefaultFilterValue
      }, 
      "title": "Default filter value to be passed to datasources", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "description": "Title of the widget. If display_name is omitted, the widget will be shown without a title.", 
      "maxLength": 255, 
      "title": "Widget Title", 
      "type": "string"
    }, 
    "drilldown_id": {
      "description": "Id of drilldown widget, if any. Id should be a valid id of an existing widget. A widget is considered as drilldown widget when it is associated with any other widget and provides more detailed information about any data item from the parent widget.", 
      "maxLength": 255, 
      "title": "Id of drilldown widget", 
      "type": "string"
    }, 
    "feature_set": {
      "$ref": "FeatureSet, 
      "description": "Features required to view the widget.", 
      "title": "Features required to view the widget"
    }, 
    "filter": {
      "description": "Id of filter widget for subscription, if any. Id should be a valid id of an existing filter widget. Filter widget should be from the same view. Datasource URLs should have placeholder values equal to filter alias to accept the filter value on filter change.", 
      "title": "Id of filter widget for subscription", 
      "type": "string"
    }, 
    "filter_value_required": {
      "default": true, 
      "description": "Flag to indicate that widget will continue to work without filter value. If this flag is set to false then default_filter_value is manadatory.", 
      "title": "Flag to indicate if filter value is necessary", 
      "type": "boolean"
    }, 
    "footer": {
      "$ref": "Footer
    }, 
    "icons": {
      "description": "Icons to be applied at dashboard for widgets and UI elements.", 
      "items": {
        "$ref": "Icon
      }, 
      "title": "Icons", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "is_drilldown": {
      "default": false, 
      "description": "Set to true if this widget should be used as a drilldown.", 
      "title": "Set as a drilldown widget", 
      "type": "boolean"
    }, 
    "legend": {
      "$ref": "Legend, 
      "description": "Legend to be displayed. If legend is not needed, do not include it.", 
      "title": "Legend for the widget"
    }, 
    "resource_type": {
      "description": "Supported visualization types are LabelValueConfiguration, DonutConfiguration, GridConfiguration, StatsConfiguration, MultiWidgetConfiguration, GraphConfiguration, ContainerConfiguration, CustomWidgetConfiguration and DropdownFilterWidgetConfiguration.", 
      "enum": [
        "LabelValueConfiguration", 
        "DonutConfiguration", 
        "MultiWidgetConfiguration", 
        "ContainerConfiguration", 
        "StatsConfiguration", 
        "GridConfiguration", 
        "GraphConfiguration", 
        "CustomWidgetConfiguration", 
        "DropdownFilterWidgetConfiguration"
      ], 
      "maxLength": 255, 
      "readonly": true, 
      "required": true, 
      "title": "Widget visualization type", 
      "type": "string"
    }, 
    "shared": {
      "deprecated": true, 
      "description": "Please use the property 'shared' of View instead of this. The widgets of a shared view are visible to other users.", 
      "title": "Visiblity of widgets to other users", 
      "type": "boolean"
    }, 
    "span": {
      "description": "Represents the horizontal span of the widget / container.", 
      "maximum": 12, 
      "minimum": 1, 
      "title": "Horizontal span", 
      "type": "int"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "weight": {
      "deprecated": true, 
      "description": "Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details.", 
      "title": "Weightage or placement of the widget or container", 
      "type": "int"
    }
  }, 
  "title": "Dashboard Widget Configuration", 
  "type": "object"
}

WidgetConfigurationList (type)

{
  "additionalProperties": false, 
  "description": "Represents a list of widget configurations.", 
  "id": "WidgetConfigurationList", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "properties": {
    "widgetconfigurations": {
      "description": "Array of widget configurations", 
      "items": {
        "$ref": "WidgetConfiguration
      }, 
      "readonly": true, 
      "required": true, 
      "title": "Array of widget configurations", 
      "type": "array"
    }
  }, 
  "title": "List of Widget Configurations", 
  "type": "object"
}

WidgetItem (type)

{
  "additionalProperties": false, 
  "description": "Represents a reference to a widget that is held by a container or a multi-widget or a View.", 
  "id": "WidgetItem", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "properties": {
    "alignment": {
      "default": "LEFT", 
      "description": "Aligns widget either left or right.", 
      "enum": [
        "LEFT", 
        "RIGHT"
      ], 
      "title": "Alignment of widget inside container", 
      "type": "string"
    }, 
    "label": {
      "$ref": "Label, 
      "description": "Applicable for 'DonutConfiguration' and 'StatsConfiguration' reports only. If label is not specified, then it defaults to the label of the donut or stats report.", 
      "title": "Label of the the report"
    }, 
    "separator": {
      "default": false, 
      "description": "If true, separates this widget in a container.", 
      "title": "A separator after this widget", 
      "type": "boolean"
    }, 
    "weight": {
      "default": 10000, 
      "description": "Determines placement of widget or container relative to other widgets and containers. The lower the weight, the higher it is in the placement order.", 
      "title": "Weightage or placement of the widget or container", 
      "type": "int"
    }, 
    "widget_id": {
      "description": "Id of the widget configuration that is held by a multi-widget or a container or a view.", 
      "maxLength": 255, 
      "required": true, 
      "title": "Id of the widget configuration", 
      "type": "string"
    }
  }, 
  "title": "Widget held by MultiWidgetConfiguration or Container or a View", 
  "type": "object"
}

WidgetQueryParameters (type)

{
  "additionalProperties": false, 
  "id": "WidgetQueryParameters", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "properties": {
    "container": {
      "description": "Id of the container whose widget configurations are to be queried.", 
      "maxLength": 255, 
      "readonly": true, 
      "title": "Id of the container", 
      "type": "string"
    }, 
    "widget_ids": {
      "description": "Comma separated ids of WidgetConfigurations to be queried.", 
      "maxLength": 8192, 
      "readonly": true, 
      "title": "Ids of the WidgetConfigurations", 
      "type": "string"
    }
  }, 
  "title": "Parameters for querying widget configurations", 
  "type": "object"
}

X509Certificate (type)

{
  "additionalProperties": false, 
  "id": "X509Certificate", 
  "module_id": "CertificateManager", 
  "properties": {
    "dsa_public_key_g": {
      "description": "One of the DSA cryptogaphic algorithm's strength parameters, base.", 
      "readonly": true, 
      "required": false, 
      "type": "string"
    }, 
    "dsa_public_key_p": {
      "description": "One of the DSA cryptogaphic algorithm's strength parameters, prime.", 
      "readonly": true, 
      "required": false, 
      "type": "string"
    }, 
    "dsa_public_key_q": {
      "description": "One of the DSA cryptogaphic algorithm's strength parameters, sub-prime.", 
      "readonly": true, 
      "required": false, 
      "type": "string"
    }, 
    "dsa_public_key_y": {
      "description": "One of the DSA cryptogaphic algorithm's strength parameters.", 
      "readonly": true, 
      "required": false, 
      "type": "string"
    }, 
    "ecdsa_curve_name": {
      "description": "The Curve name for the ECDSA certificate.", 
      "readonly": true, 
      "required": false, 
      "title": "ECDSA Curve Name", 
      "type": "string"
    }, 
    "ecdsa_ec_field": {
      "description": "Represents an elliptic curve (EC) finite field in ECDSA.", 
      "enum": [
        "F2M", 
        "FP"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "ECDSA Elliptic Curve Finite Field", 
      "type": "string"
    }, 
    "ecdsa_ec_field_f2mks": {
      "description": "The order of the middle term(s) of the reduction polynomial in elliptic curve (EC) | characteristic 2 finite field.| Contents of this array are copied to protect against subsequent modification in ECDSA.", 
      "items": {
        "type": "integer"
      }, 
      "readonly": true, 
      "required": false, 
      "title": "ECDSA Elliptic Curve F2MKS", 
      "type": "array"
    }, 
    "ecdsa_ec_field_f2mm": {
      "description": "The first coefficient of this elliptic curve in elliptic curve (EC) | characteristic 2 finite field for ECDSA.", 
      "readonly": true, 
      "required": false, 
      "title": "ECDSA Elliptic Curve F2MM", 
      "type": "integer"
    }, 
    "ecdsa_ec_field_f2mrp": {
      "description": "The value whose i-th bit corresponds to the i-th coefficient of the reduction polynomial | in elliptic curve (EC) characteristic 2 finite field for ECDSA.", 
      "readonly": true, 
      "required": false, 
      "title": "ECDSA Elliptic Curve F2MRP", 
      "type": "string"
    }, 
    "ecdsa_ec_field_f2pp": {
      "description": "The specified prime for the elliptic curve prime finite field in ECDSA.", 
      "readonly": true, 
      "required": false, 
      "title": "ECDSA Elliptic Curve F2PP", 
      "type": "string"
    }, 
    "ecdsa_public_key_a": {
      "description": "The first coefficient of this elliptic curve in ECDSA.", 
      "readonly": true, 
      "required": false, 
      "title": "ECDSA Elliptic Curve Public Key A", 
      "type": "string"
    }, 
    "ecdsa_public_key_b": {
      "description": "The second coefficient of this elliptic curve in ECDSA.", 
      "readonly": true, 
      "required": false, 
      "title": "ECDSA Elliptic Curve Public Key B", 
      "type": "string"
    }, 
    "ecdsa_public_key_cofactor": {
      "description": "The co-factor in ECDSA.", 
      "readonly": true, 
      "required": false, 
      "title": "ECDSA Elliptic Curve Public Key Cofactor", 
      "type": "integer"
    }, 
    "ecdsa_public_key_generator_x": {
      "description": "X co-ordinate of G (the generator which is also known as the base point) in ECDSA.", 
      "readonly": true, 
      "required": false, 
      "title": "ECDSA Elliptic Curve Public Key X", 
      "type": "string"
    }, 
    "ecdsa_public_key_generator_y": {
      "description": "Y co-ordinate of G (the generator which is also known as the base point) in ECDSA.", 
      "readonly": true, 
      "required": false, 
      "title": "ECDSA Elliptic Curve Public Key Y", 
      "type": "string"
    }, 
    "ecdsa_public_key_order": {
      "description": "The order of generator G in ECDSA.", 
      "readonly": true, 
      "required": false, 
      "title": "ECDSA Elliptic Curve Public Key Order", 
      "type": "string"
    }, 
    "ecdsa_public_key_seed": {
      "description": "The bytes used during curve generation for later validation in ECDSA.| Contents of this array are copied to protect against subsequent modification.", 
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "required": false, 
      "title": "ECDSA Elliptic Curve Public Key Seed", 
      "type": "array"
    }, 
    "is_ca": {
      "description": "True if this is a CA certificate.", 
      "readonly": true, 
      "required": true, 
      "type": "boolean"
    }, 
    "is_valid": {
      "description": "True if this certificate is valid.", 
      "readonly": true, 
      "required": true, 
      "type": "boolean"
    }, 
    "issuer": {
      "description": "The certificate issuers complete distinguished name.", 
      "readonly": true, 
      "required": true, 
      "type": "string"
    }, 
    "issuer_cn": {
      "description": "The certificate issuer's common name.", 
      "readonly": true, 
      "required": true, 
      "type": "string"
    }, 
    "not_after": {
      "$ref": "EpochMsTimestamp, 
      "description": "The time in epoch milliseconds at which the certificate becomes invalid.", 
      "readonly": true, 
      "required": true
    }, 
    "not_before": {
      "$ref": "EpochMsTimestamp, 
      "description": "The time in epoch milliseconds at which the certificate becomes valid.", 
      "readonly": true, 
      "required": true
    }, 
    "public_key_algo": {
      "description": "Cryptographic algorithm used by the public key for data encryption.", 
      "enum": [
        "RSA", 
        "DSA", 
        "ECDSA"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Public Key Algorithm", 
      "type": "string"
    }, 
    "public_key_length": {
      "description": "Size measured in bits of the public/private keys used in a cryptographic algorithm.", 
      "readonly": true, 
      "required": true, 
      "type": "integer"
    }, 
    "rsa_public_key_exponent": {
      "description": "An RSA public key is made up of the modulus and the public exponent. Exponent is a power number.", 
      "readonly": true, 
      "required": false, 
      "type": "string"
    }, 
    "rsa_public_key_modulus": {
      "description": "An RSA public key is made up of the modulus and the public exponent. Modulus is wrap around number.", 
      "readonly": true, 
      "required": false, 
      "type": "string"
    }, 
    "serial_number": {
      "description": "Certificate's serial number.", 
      "readonly": true, 
      "required": true, 
      "type": "string"
    }, 
    "signature": {
      "description": "The signature value(the raw signature bits) used for signing and validate the cert.", 
      "readonly": true, 
      "required": true, 
      "type": "string"
    }, 
    "signature_algorithm": {
      "description": "The algorithm used by the Certificate Authority to sign the certificate.", 
      "readonly": true, 
      "required": true, 
      "type": "string"
    }, 
    "subject": {
      "description": "The certificate owners complete distinguished name.", 
      "readonly": true, 
      "required": true, 
      "type": "string"
    }, 
    "subject_cn": {
      "description": "The certificate owner's common name.", 
      "readonly": true, 
      "required": true, 
      "type": "string"
    }, 
    "version": {
      "description": "Certificate version (default v1).", 
      "readonly": true, 
      "required": true, 
      "type": "string"
    }
  }, 
  "type": "object"
}

X509Crl (type)

{
  "additionalProperties": false, 
  "id": "X509Crl", 
  "module_id": "CertificateManager", 
  "properties": {
    "crl_entries": {
      "description": "List of X509CrlEntry.", 
      "items": {
        "$ref": "X509CrlEntry
      }, 
      "readonly": true, 
      "required": false, 
      "type": "array"
    }, 
    "issuer": {
      "description": "Issuer's distinguished name. (DN)", 
      "readonly": true, 
      "required": false, 
      "type": "string"
    }, 
    "next_update": {
      "description": "Next update time for the CRL.", 
      "readonly": true, 
      "required": false, 
      "type": "string"
    }, 
    "version": {
      "description": "CRL's version number either 1 or 2.", 
      "readonly": true, 
      "required": false, 
      "type": "string"
    }
  }, 
  "title": "A CRL is a time-stamped list identifying revoked certificates.", 
  "type": "object"
}

X509CrlEntry (type)

{
  "additionalProperties": false, 
  "id": "X509CrlEntry", 
  "module_id": "CertificateManager", 
  "properties": {
    "revocation_date": {
      "description": "Revocation date.", 
      "readonly": true, 
      "required": false, 
      "type": "string"
    }, 
    "serial_number": {
      "description": "The revoked certificate's serial number.", 
      "readonly": true, 
      "required": false, 
      "type": "string"
    }
  }, 
  "title": "Each revoked certificate is identified in a CRL by its certificate serial number.", 
  "type": "object"
}

API Errors

301 - Moved Permanently

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

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

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

Response Code	400 Bad Request
Response Headers	Content-Type: text/plain
Response Body	Additional information about the error, if available.

401 - Unauthorized

Response Code	401 Unauthorized
Response Headers
Response Body	Additional information about the error, if available.

403 - Forbidden

Response Code	403 Forbidden
Response Headers	Content-Type: text/plain
Response Body	Additional information about the error, if available.

404 - Not Found

Response Code	404 Not Found
Response Headers	Content-Type: text/plain
Response Body	Additional information about the error, if available.

409 - Conflict

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

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

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.

Deprecated Types and Methods

** Deprecated Type Definitions

ChildCommunicationMap:
    Child wrapper object for CommunicationMap, used in hierarchical API This
    type is deprecated. Use the type ChildSecurityPolicy instead.
ChildL2Vpn:
    Child wrapper object for L2Vpn, used in hierarchical API.
L2VpnContext:
    L2Vpn Context provides meta-data information about the parent Tier-0.
L3Vpn:
    Contains information necessary to configure IPSec VPN.
PolicyDHGroup:
    Diffie-Hellman groups represent algorithm used to derive shared keys between
    IPSec VPN initiator and responder over an unsecured network. GROUP2 uses
    1024-bit Modular Exponentiation (MODP) group. GROUP5 uses 1536-bit MODP
    group. GROUP14 uses 2048-bit MODP group. GROUP15 uses 3072-bit MODP group.
    GROUP16 uses 4096-bit MODP group.
CommunicationMap:
    Ordered list of CommunicationEntries. This object is created by default
    along with the Domain. This type is deprecated. Use the type SecurityPolicy
    instead.
CommunicationEntry:
    A communication entry indicates the action to be performed for various types
    of traffic flowing between workload groups. This type is deprecated. Use the
    type Rule instead.
PolicyIPAddressInfo:
    Used to specify the display name and value of the IPv4Address.
PolicyIKEDigestAlgorithm:
    The IKEDigestAlgorithms are used to verify message integrity during IKE
    negotiation. SHA1 produces 160 bits hash and SHA2_256 produces 256 bit hash.
L3VpnSessionResourceType:
    - A Policy Based L3Vpn is a configuration in which protect rules to match
    local and remote subnet needs to be defined. Tunnel is established for each
    pair of local and remote subnet defined in protect rules. - A Route Based
    L3Vpn is more flexible, more powerful and recommended over policy based. IP
    Tunnel subnet is created and all traffic routed through tunnel subnet
    (commonly known as VTI) is sent over tunnel. Routes can be learned through
    BGP. A route based L3Vpn is required when using redundant L3Vpn.
ChildL3VpnContext:
    Child wrapper object for L3VpnContext, used in hierarchical API.
ChildDeploymentZone:
    Child wrapper object for DeploymentZone, used in hierarchical API
L3VpnContext:
    L3Vpn Context provides the configuration context that different L3Vpns can
    consume.
PolicyTunnelDigestAlgorithm:
    The TunnelDigestAlgorithms are used to verify message integrity during
    tunnel establishment. SHA1 produces 160 bits hash and SHA2_256 produces 256
    bit hash.
L3VpnSubnet:
    Used to specify subnets in L3Vpn rule.
ChildL2VpnContext:
    Child wrapper object for L2VpnContext, used in hierarchical API.
ChildCommunicationEntry:
    Child wrapper object for CommunicationEntry, used in hierarchical API This
    type is deprecated. Use the type ChildRule instead.
TunnelSubnet:
    (missing)
L3VpnRule:
    For policy-based L3Vpn sessions, a rule specifies as its action the vpn
    tunnel to be used for transit traffic that meets the rule's match criteria.
PolicyTunnelEncryptionAlgorithm:
    TunnelEncryption algorithms are used to ensure confidentiality of the
    messages exchanged during Tunnel negotiations. AES stands for Advanced
    Encryption Standards. AES_128 uses 128-bit keys whereas AES_256 uses 256-bit
    keys for encryption and decryption. AES_GCM stands for Advanced Encryption
    Standard(AES) in Galois/Counter Mode (GCM) and is used to provide both
    confidentiality and data origin authentication.
L3VpnSession:
    Contains information about L3Vpn session.
L2Vpn:
    Contains information necessary to configure L2Vpn.
PolicyIKEEncryptionAlgorithm:
    IKEEncryption algorithms are used to ensure confidentiality of the messages
    exchanged during IKE negotiations. AES stands for Advanced Encryption
    Standards. AES_128 uses 128-bit keys whereas AES_256 uses 256-bit keys for
    encryption and decryption. AES_GCM stands for Advanced Encryption
    Standard(AES) in Galois/Counter Mode(GCM) and is used to provide both
    confidentiality and data origin authentication. AES_GCM composed of two
    separate functions one for encryption(AES) and one for authentication(GMAC).
    AES_GCM algorithms will be available with IKE_V2 version only. AES_GMAC_128
    uses 128-bit keys. AES_GMAC_192 uses 192-bit keys. AES_GMAC_256 uses 256-bit
    keys.
ChildL3Vpn:
    Child wrapper object for L3Vpn, used in hierarchical API.
PolicyBasedL3VpnSession:
    A Policy-based L3Vpn session is a configuration in which a specific vpn
    tunnel is referenced in a policy whose action is set as tunnel.
DeploymentZone:
    Logical grouping of enforcement points. This is a deprecated type.
    DeploymentZone has been renamed to Site. Use Site.
RouteBasedL3VpnSession:
    A Route Based L3Vpn is more flexible, more powerful and recommended over
    policy based. IP Tunnel subnet is created and all traffic routed through
    tunnel subnet is sent over tunnel. Routes can be learned through BGP. A
    route based L3Vpn is required when using redundant L3Vpn.
PolicyIKEVersion:
    IKE protocol version to be used. IKE-Flex will initiate IKE-V2 and responds
    to both IKE-V1 and IKE-V2.
GroupDeleteRequestParameters:
    Group delete request parameters


** Deprecated Property Definitions

DropdownFilterWidgetConfiguration.weight:
    Specify relavite weight in WidgetItem for placement in a view. Please see
    WidgetItem for details.
DropdownFilterWidgetConfiguration.shared:
    Please use the property 'shared' of View instead of this. The widgets of a
    shared view are visible to other users.
Segment.address_bindings:
    Static address binding used for the Segment. This field is deprecated and
    will be removed in a future release. Please use address_bindings in
    SegmentPort to configure static bindings.
Segment.ls_id:
    This property is deprecated. The property will continue to work as expected
    for existing segments. The segments that are newly created with ls_id will
    be ignored. Sepcify pre-creted logical switch id for Segment.
LBService.access_log_enabled:
    Flag to enable access log
ContainerConfiguration.weight:
    Specify relavite weight in WidgetItem for placement in a view. Please see
    WidgetItem for details.
ContainerConfiguration.shared:
    Please use the property 'shared' of View instead of this. The widgets of a
    shared view are visible to other users.
WidgetConfiguration.weight:
    Specify relavite weight in WidgetItem for placement in a view. Please see
    WidgetItem for details.
WidgetConfiguration.shared:
    Please use the property 'shared' of View instead of this. The widgets of a
    shared view are visible to other users.
UpgradeCheck.failure_messages:
    List of failure messages. This field is deprecated now. Please use failures
    instead.
L2Extension.l2vpn_path:
    This property has been deprecated. Please use the property l2vpn_paths for
    setting the paths of associated L2 VPN session. This property will continue
    to work as expected to provide backwards compatibility. However, when both
    l2vpn_path and l2vpn_paths properties are specified, only l2vpn_paths is
    used.
BgpRoutingConfig.graceful_restart:
    Flag to enable graceful restart. This field is deprecated, please use
    graceful_restart_config parameter for graceful restart configuration. If
    both parameters are set and consistent with each other (i.e.
    graceful_restart=false and graceful_restart_mode=HELPER_ONLY OR
    graceful_restart=true and graceful_restart_mode=GR_AND_HELPER) then this is
    allowed, but if inconsistent with each other then this is not allowed and
    validation error will be thrown.
GridConfiguration.weight:
    Specify relavite weight in WidgetItem for placement in a view. Please see
    WidgetItem for details.
GridConfiguration.shared:
    Please use the property 'shared' of View instead of this. The widgets of a
    shared view are visible to other users.
MultiWidgetConfiguration.weight:
    Specify relavite weight in WidgetItem for placement in a view. Please see
    WidgetItem for details.
MultiWidgetConfiguration.shared:
    Please use the property 'shared' of View instead of this. The widgets of a
    shared view are visible to other users.
PolicyUrlCategorizationConfig.context_profiles:
    The ids of the context profiles that provides the list of categories to be
    detected. This field is deprecated. URL Categorization will not be supported
    in association with context profiles.
NSXTConnectionInfo.edge_cluster_ids:
    Edge Cluster UUIDs on enforcement point. Edge cluster information is
    required for creating logical L2, L3 constructs on enforcement point. Max 1
    edge cluster ID. This is a deprecated property. The edge cluster id is now
    auto populated from enforcement point and its value can be read using APIs
    GET /infra/sites/site-id/enforcement-points/enforcementpoint-id/edge-
    clusters and GET /infra/sites/site-id/enforcement-points/enforcementpoint-1
    /edge-clusters/edge-cluster-id. The value passed through this property will
    be ignored.
NSXTConnectionInfo.transport_zone_ids:
    Transport Zone UUIDs on enforcement point. Transport zone information is
    required for creating logical L2, L3 constructs on enforcement point. Max 1
    transport zone ID. This is a deprecated property. The transport zone id is
    now auto populated from enforcement point and its value can be read using
    APIs GET /infra/sites/site-id/enforcement-points/enforcementpoint-id
    /transport-zones and GET /infra/sites/site-id/enforcement-points
    /enforcementpoint-id/transport-zones/transport-zone-id. The value passed
    through this property will be ignored.
AbstractSpace.connectivity_strategy:
    The connectivity strategy is deprecated. Use default layer3 rule,
    /infra/domains/default/security-policies/default-layer3-security-
    policy/rules/default-layer3-rule. 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
    WHITELIST_ENABLE_LOGGING - Whitelising with logging enabled
    BLACKLIST_ENABLE_LOGGING - Blacklisting with logging enabled NONE - No
    default rules are added.
DonutConfiguration.weight:
    Specify relavite weight in WidgetItem for placement in a view. Please see
    WidgetItem for details.
DonutConfiguration.shared:
    Please use the property 'shared' of View instead of this. The widgets of a
    shared view are visible to other users.
GraphConfiguration.weight:
    Specify relavite weight in WidgetItem for placement in a view. Please see
    WidgetItem for details.
GraphConfiguration.shared:
    Please use the property 'shared' of View instead of this. The widgets of a
    shared view are visible to other users.
FilterWidgetConfiguration.weight:
    Specify relavite weight in WidgetItem for placement in a view. Please see
    WidgetItem for details.
FilterWidgetConfiguration.shared:
    Please use the property 'shared' of View instead of this. The widgets of a
    shared view are visible to other users.
LBHttpProfile.ntlm:
    NTLM is an authentication protocol that can be used over HTTP. If the flag
    is set to true, LB will use NTLM challenge/response methodology. This
    property is deprecated. Please use the property server_keep_alive in order
    to keep the backend server connection alive for the client connection. When
    create a new profile, if both ntlm and server_keep_alive are set as
    different values, ERROR will be reported. When update an existing profile,
    if either ntlm or server_keep_alive value is changed, both of them are
    updated with the changed value.
LocaleServices.route_redistribution_types:
    Enable redistribution of different types of routes on Tier-0. This property
    is only valid for locale-service under Tier-0. This property is deprecated,
    please use "route_redistribution_config" property to configure
    redistribution rules.
StatsConfiguration.weight:
    Specify relavite weight in WidgetItem for placement in a view. Please see
    WidgetItem for details.
StatsConfiguration.shared:
    Please use the property 'shared' of View instead of this. The widgets of a
    shared view are visible to other users.
LabelValueConfiguration.weight:
    Specify relavite weight in WidgetItem for placement in a view. Please see
    WidgetItem for details.
LabelValueConfiguration.shared:
    Please use the property 'shared' of View instead of this. The widgets of a
    shared view are visible to other users.
Infra.connectivity_strategy:
    The connectivity strategy is deprecated. Use default layer3 rule,
    /infra/domains/default/security-policies/default-layer3-security-
    policy/rules/default-layer3-rule. 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
    WHITELIST_ENABLE_LOGGING - Whitelising with logging enabled
    BLACKLIST_ENABLE_LOGGING - Blacklisting with logging enabled NONE - No
    default rules are added.
ChildServiceEntry.Service:
    This is a deprecated property, Please use 'ServiceEntry' instead.
Tier1.default_rule_logging:
    Indicates if logging should be enabled for the default whitelisting rule.
    This field is deprecated and recommended to change Rule logging field. Note
    that this field is not synchronized with default logging field.
Tier1.force_whitelisting:
    This field is deprecated and recommended to change Rule action field. Note
    that this field is not synchornied with default rule field.
Tier0.default_rule_logging:
    Indicates if logging should be enabled for the default whitelisting rule.
    This field is deprecated and recommended to change Rule logging field. Note
    that this field is not synchronized with default logging field.
Tier0.force_whitelisting:
    This field is deprecated and recommended to change Rule action field. Note
    that this field is not synchronized with default rule field.
RouteBasedL3VpnSession.routing_config_path:
    This is a deprecated field. Any specified value is not saved and will be
    ignored.
DhcpServerConfig.server_address:
    DHCP server address in CIDR format. Prefix length should be less than or
    equal to 30. DHCP server is deployed as DHCP relay service. This property is
    deprecated, use server_addresses instead. Both properties cannot be
    specified together with different new values.
CustomWidgetConfiguration.weight:
    Specify relavite weight in WidgetItem for placement in a view. Please see
    WidgetItem for details.
CustomWidgetConfiguration.shared:
    Please use the property 'shared' of View instead of this. The widgets of a
    shared view are visible to other users.
IdsProfile.severities:
    Represents the severities of signatures which are part of this profile.
BgpNeighborConfig.in_route_filters:
    Specify path of prefix-list or route map to filter routes for IN direction.
    This property is deprecated, use route_filtering instead. Specifying
    different values for both properties will result in error.
BgpNeighborConfig.out_route_filters:
    Specify path of prefix-list or route map to filter routes for OUT direction.
    When not specified, a built-in prefix-list named 'prefixlist-out-default' is
    automatically applied. This property is deprecated, use route_filtering
    instead. Specifying different values for both properties will result in
    error.
NsxRole.permissions:
    Please use the /user-info/permissions api to get the permission that the
    user has on each feature.
Tier0Interface.edge_cluster_member_index:
    Specify association of interface with edge cluster member. This property is
    deprecated, use edge_path instead. When both properties are specifed, only
    edge_path property is used.
Tier0Interface.ls_id:
    Specify logical switch to which tier-0 interface is connected for external
    access. This property is deprecated, use segment_path instead. Both
    properties cannot be used together.
RouteBasedIPSecVpnSession.force_whitelisting:
    If true the default firewall rule Action is set to DROP, otherwise set to
    ALLOW. This filed is deprecated and recommended to change Rule action filed.
    Note that this filed is not synchornied with default rule field.


** Deprecated APIs

UpdateProxyService (PUT /node/services/http):
    This API is deprecated.  Make changes to the http service configuration by
    calling the PUT /api/v1/cluster/api-service API.
UploadUpgradeBundle (POST /upgrade/bundle?action=upload):
    Upload the upgrade bundle. The call returns after upload is initiated. User
    needs to check upload status periodically by retrieving upgrade bundle
    upload status to find out if the upload is completed. This API is
    deprecated, please use /upgrade/bundles?action=upload API to upload the
    upgrade bundle.
InvokeDeleteFabricCentralAPI (DELETE /fabric/nodes//):
    Invoke DELETE request on target fabric node. This api is deprecated as part
    of FN+TN unification. Please use Transport Node API DELETE /transport-
    nodes/<transport-node-id>/<target-node-id>/<target-uri>
ClearClusterCertificate (POST /cluster/api-certificate?action=clear_cluster_certificate):
    Clears the certificate used for the MP cluster. This does not affect the
    certificate itself. This API is deprecated. Instead use the  /api/v1/cluster
    /api-certificate?action=set_cluster_certificate API to set the cluster
    certificate to a different one. It just means that from now on, individual
    certificates will be used on each MP node. This affects all nodes in the
    cluster.
InvokePutFabricCentralAPI (PUT /fabric/nodes//):
    Invoke PUT request on target fabric node. This api is deprecated as part of
    FN+TN unification. Please use Transport Node API PUT /transport-nodes/<
    ;transport-node-id>/<target-node-id>/<target-uri>
ReadProxyService (GET /node/services/http):
    This API is deprecated.  Read the configuration of the http service by
    calling the GET /api/v1/cluster/api-service API.
InvokePostFabricCentralAPI (POST /fabric/nodes//):
    Invoke POST request on target fabric node. This api is deprecated as part of
    FN+TN unification. Please use Transport Node API POST /transport-nodes/<
    ;transport-node-id>/<target-node-id>/<target-uri>
InvokeGetFabricCentralAPI (GET /fabric/nodes//):
    Invoke GET request on target fabric node. This api is deprecated as part of
    FN+TN unification. Please use Transport Node API GET /transport-nodes/<
    ;transport-node-id>/<target-node-id>/<target-uri>