MetadataProxy (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.
array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.
int
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
attached_logical_port_id id of attached logical port string Readonly
crypto_protocols metadata proxy supported cryptographic protocols.

The cryptographic protocols listed here are supported by the metadata proxy.
The TLSv1.1 and TLSv1.2 are supported by default.
array of MetadataProxyCryptoProtocol
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set
string Maximum length: 255
Sortable
edge_cluster_id edge cluster uuid string Required
edge_cluster_member_indexes edge cluster member indexes

If none is provided, the NSX will auto-select two edge-nodes from the given edge cluster.
If user provides only one edge node, there will be no HA support.
array of integer Minimum items: 0
Maximum items: 2
enable_standby_relocation Flag to enable standby Metadata proxy server relocation

Flag to enable the auto-relocation of standby Metadata Proxy in
case of edge node failure. Only tier 1 and auto placed Metadata
Proxy are considered for the relocation.
boolean Default: "False"
id Unique identifier of this resource string Sortable
metadata_server_ca_ids uuids of CAs to verify metadata server certificate

The CAs referenced here must be uploaded to the truststore using the API
POST /api/v1/trust-management/certificates?action=import.
User needs to ensure a correct CA for this metedata server is used. The REST API can
not detect a wrong CA which was used to verify a different server. If the Metadata
Proxy reports an ERROR or NO_BACKUP status, user can check the metadata proxy log
at transport node for a possible CA issue.
array of string
metadata_server_url metadata server url

The URL in format scheme://host:port/path. Please note, the scheme supports only http
and https as of now, port supports range 3000 - 9000, inclusive.
string Required
resource_type Must be set to the value MetadataProxy string
secret secret to access metadata server string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30