NSX-T Data Center REST API

AdvertisementConfig (schema)

Advertisement config

Advertisement config for different types of
routes which need to be advertised from TIER1 logical
router to the linked TIER0 logical router

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

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

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

The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.
int
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
advertise_dns_forwarder Advertise dns forwarder ips

Flag to advertise all routes of dns forwarder listener ips and source ips
boolean Default: "False"
advertise_ipsec_local_ip Advertise IPSec VPN local endpoint ips

Flag to advertise all IPSec VPN local endpoint ips to linked TIER0 logical router
boolean Default: "False"
advertise_lb_snat_ip Advertise lb SNAT ips

Flag to advertise all lb SNAT ips
boolean Default: "False"
advertise_lb_vip Advertise lb vip ips

Flag to advertise lb vip ips
boolean Default: "False"
advertise_nat_routes Advertise NAT routes

Flag to advertise all routes of nat
boolean Default: "False"
advertise_nsx_connected_routes Advertise connected routes

Flag to advertise all connected routes
boolean Default: "False"
advertise_static_routes Advertise static routes

Flag to advertise all static routes
boolean Default: "False"
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set
string Maximum length: 255
Sortable
enabled Enable advertisement

Flag to enable this configuration
boolean Default: "False"
id Unique identifier of this resource string Sortable
logical_router_id Logical router id

TIER1 logical router id on which to enable this configuration
string Readonly
resource_type Must be set to the value AdvertisementConfig string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30