ocket8888 commented on a change in pull request #5450:
URL: https://github.com/apache/trafficcontrol/pull/5450#discussion_r563027170
##########
File path: docs/source/api/v4/servers_id.rst
##########
@@ -49,21 +49,21 @@ Request Structure
:iloUsername: An optional string containing the user name for the server's
:abbr:`ILO (Integrated Lights-Out)` service\ [#ilo]_
:interfaces: A set of the network interfaces in use by the server. In most
scenarios, only one will be necessary, but it is illegal for this set to be an
empty collection.
- :ipAddresses: A set of objects representing IP Addresses assigned to
this network interface. In most scenarios, only one or two (usually one IPv4
address and one IPv6 address) will be necessary, but it is illegal for this set
to be an empty collection.
+ :ipAddresses: A set of objects representing IP Addresses assigned
to this network interface. In most scenarios, only one or two (usually one IPv4
address and one IPv6 address) will be necessary, but it is illegal for this set
to be an empty collection.
:address: The actual IP address, including any mask as a
CIDR-notation suffix
:gateway: Either the IP address of the network gateway
for this address, or ``null`` to signify that no such gateway exists
:serviceAddress: A boolean that describes whether or not the
server's main service is available at this IP address. When this property is
``true``, the IP address is referred to as a "service address". It is illegal
for a server to not have at least one service address. It is also illegal for a
server to have more than one service address of the same address family (i.e.
more than one IPv4 service address and/or more than one IPv6 address). Finally,
all service addresses for a server must be contained within one interface -
which is therefore sometimes referred to as the "service interface" for the
server.
- :maxBandwidth: The maximum healthy bandwidth allowed for this
interface. If bandwidth exceeds this limit, Traffic Monitors will consider the
entire server unhealthy - which includes *all* configured network interfaces.
If this is ``null``, it has the meaning "no limit". It has no effect if
``monitor`` is not true for this interface.
+ :maxBandwidth: The maximum healthy bandwidth allowed for this
interface. If bandwidth exceeds this limit, Traffic Monitors will consider the
entire server unhealthy - which includes *all* configured network interfaces.
If this is ``null``, it has the meaning "no limit". It has no effect if
``monitor`` is not true for this interface.
.. seealso:: :ref:`health-proto`
- :monitor: A boolean which describes whether or not this interface
should be monitored by Traffic Monitor for statistics and health consideration.
- :mtu: The :abbr:`MTU (Maximum Transmission Unit)` of this
interface. If it is ``null``, it may be assumed that the information is either
not available or not applicable for this interface. This unsigned integer must
not be less than 1280.
- :name: The name of the interface. No two interfaces of the same
server may share a name. It is the same as the network interface's device name
on the server, e.g. ``eth0``.
- :routerHostName: An optional string containing The human-readable name of
the router responsible for reaching this server's interface.
- :routerPort: An optional string containing The human-readable name of the
port used by the router responsible for reaching this server's interface.
+ :monitor: A boolean which describes whether or not this
interface should be monitored by Traffic Monitor for statistics and health
consideration.
+ :mtu: The :abbr:`MTU (Maximum Transmission Unit)` of this
interface. If it is ``null``, it may be assumed that the information is either
not available or not applicable for this interface. This unsigned integer must
not be less than 1280.
+ :name: The name of the interface. No two interfaces of the
same server may share a name. It is the same as the network interface's device
name on the server, e.g. ``eth0``.
+ :routerHostName: An optional string containing The human-readable name
of the router responsible for reaching this server's interface.
+ :routerPort: An optional string containing The human-readable name
of the port used by the router responsible for reaching this server's interface.
Review comment:
these are still indented with spaces instead of tabs
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
