TransportNodeProfile (schema)

Transport Node 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
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set
string Maximum length: 255
Sortable
host_switch_spec Transport node host switch specification

The HostSwitchSpec is the base class for standard and preconfigured
host switch specifications. Only standard host switches are supported
in the transport node profile.
HostSwitchSpec
(Abstract type: pass one of the following concrete types)
PreconfiguredHostSwitchSpec
StandardHostSwitchSpec
id Unique identifier of this resource string Sortable
ignore_overridden_hosts Determines if cluster-level configuration should be applied on overridden hosts

Transport Node Profiles specify the configuration that is applied to all
hosts in a cluster. The user has the ability to update the configuration
on individual hosts within a cluster which will cause the host configuration
to differ from the Transport Node Profile and results in the host to be
marked as overridden. If a Transport Node Profile is edited or a new
Transport Node Profile is applied on a Transport Node Collection, by default,
the host configuration will be overwritten with the Transport Node Profile
configuration and the overridden flag will be reset to false. This flag
should be used when hosts that are set as overridden should not adopt the
Transport Node Profile configuration when it is being updated or a new one
is applied to the Transport Node Collection. In other words, when this flag is
set to the default value of false and configuration is applied at the cluster
level, the configuration will be applied on all hosts regardless if overridden
or not. When this flag is set to true, all hosts that are set as overridden, i.e.,
have been updated invidivually, will be ignored and the cluster-level configuration
will not be applied.
Note, Transport Node Profiles can be applied on multiple clusters. This field will
dictate the behavior followed by all clusters using this Transport Node Profile.
boolean Default: "False"
resource_type Must be set to the value TransportNodeProfile string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
transport_zone_endpoints Transport zone endpoints.

This is deprecated. TransportZoneEndPoints should be specified
per host switch at StandardHostSwitch through Transport Node
or Transport Node Profile configuration.
This will ONLY include the TransportZoneEndpoints that were
were specified here during the TransportNode configuration.
If TransportZoneEndpoints are specified directly in
{$ref: StandardHostSwitch}, such TransportZoneEndpoints
will not be populated here.
array of TransportZoneEndPoint Deprecated