reformat with latest settings
Reformat with the latest settings from openbmc-build-scripts (and
copy latest config files where appropriate). Fix a few minor
markdownlint issues.
Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Change-Id: I55205817c29dc3f182a165ddf9cd5d4e07b90063
diff --git a/yaml/xyz/openbmc_project/Network/Client.interface.yaml b/yaml/xyz/openbmc_project/Network/Client.interface.yaml
index 188bcd9..9789e47 100644
--- a/yaml/xyz/openbmc_project/Network/Client.interface.yaml
+++ b/yaml/xyz/openbmc_project/Network/Client.interface.yaml
@@ -1,8 +1,7 @@
description: >
- This defines the network endpoint.
- Application which wants to keep the network endpoint info
- can use this interface.
- e.g: Network endpoint could be SNMP mangers or LDAP servers etc.
+ This defines the network endpoint. Application which wants to keep the
+ network endpoint info can use this interface. e.g: Network endpoint could be
+ SNMP mangers or LDAP servers etc.
properties:
- name: Address
type: string
diff --git a/yaml/xyz/openbmc_project/Network/DHCPConfiguration.interface.yaml b/yaml/xyz/openbmc_project/Network/DHCPConfiguration.interface.yaml
index 74b7939..44dab9c 100644
--- a/yaml/xyz/openbmc_project/Network/DHCPConfiguration.interface.yaml
+++ b/yaml/xyz/openbmc_project/Network/DHCPConfiguration.interface.yaml
@@ -4,25 +4,25 @@
- name: DNSEnabled
type: boolean
description: >
- if true then the DNS servers received from the DHCP server
- will be used and take precedence over any statically configured ones.
+ if true then the DNS servers received from the DHCP server will be
+ used and take precedence over any statically configured ones.
- name: NTPEnabled
type: boolean
description: >
- if true then the NTP servers received from the DHCP server
- will be used by systemd-timesyncd and take precedence over any
- statically configured ones.
+ if true then the NTP servers received from the DHCP server will be
+ used by systemd-timesyncd and take precedence over any statically
+ configured ones.
- name: HostNameEnabled
type: boolean
description: >
- if true then the hostname received from the DHCP server
- will be set as the transient hostname of the system.
+ if true then the hostname received from the DHCP server will be set as
+ the transient hostname of the system.
- name: DomainEnabled
type: boolean
description: >
- if true then the domain names received from the DHCP server
- will be used by systemd-resolved and take precedence over any
- statically configured ones.
+ if true then the domain names received from the DHCP server will be
+ used by systemd-resolved and take precedence over any statically
+ configured ones.
- name: SendHostNameEnabled
type: boolean
description: >
diff --git a/yaml/xyz/openbmc_project/Network/EthernetInterface.interface.yaml b/yaml/xyz/openbmc_project/Network/EthernetInterface.interface.yaml
index f45cac7..f39fd13 100644
--- a/yaml/xyz/openbmc_project/Network/EthernetInterface.interface.yaml
+++ b/yaml/xyz/openbmc_project/Network/EthernetInterface.interface.yaml
@@ -1,7 +1,6 @@
description: >
- This defines an ethernet interface.
- An object implementing this interface must implement
- xyz.openbmc_project.State.OperationalStatus.
+ This defines an ethernet interface. An object implementing this interface
+ must implement xyz.openbmc_project.State.OperationalStatus.
properties:
- name: InterfaceName
@@ -27,8 +26,8 @@
type: size
default: 0
description: >
- This indicates the size in bytes of largest protocol data unit,
- which can be passed in an Ethernet frame on the interface.
+ This indicates the size in bytes of largest protocol data unit, which
+ can be passed in an Ethernet frame on the interface.
- name: DomainName
type: array[string]
description: >
@@ -36,8 +35,8 @@
- name: DHCPEnabled
type: enum[self.DHCPConf]
description: >
- Address mode of the ethernet interface. Deprecated in favor of
- split options to avoid combinatorics.
+ Address mode of the ethernet interface. Deprecated in favor of split
+ options to avoid combinatorics.
- name: DHCP4
type: boolean
description: >
@@ -56,8 +55,8 @@
type: array[string]
description: >
A statically defined set of DNS server IP addresses to be used when
- DHCP provisioning is not enabled for name server configuration. As
- an implementation option this may also be used in addition to DHCP
+ DHCP provisioning is not enabled for name server configuration. As an
+ implementation option this may also be used in addition to DHCP
provided addresses, or in cases where the DHCP server provides no DNS
assigments.
errors:
@@ -65,14 +64,14 @@
- name: NTPServers
type: array[string]
description: >
- NTP servers that are currently in use on this interface.
- This includes both DHCP and static NTP server addresses.
+ NTP servers that are currently in use on this interface. This includes
+ both DHCP and static NTP server addresses.
- name: StaticNTPServers
type: array[string]
description: >
This property describes statically defined NTPServers on the
- interface. This property supports read/write operation.
- Configure the NTP servers on the system during write operation.
+ interface. This property supports read/write operation. Configure the
+ NTP servers on the system during write operation.
- name: LinkLocalAutoConf
type: enum[self.LinkLocalConf]
description: >
@@ -92,8 +91,8 @@
- readonly
description: >
This property reports the link status for the NIC. The read-only
- boolean value is TRUE when the network cable is inserted, or there
- is a carrier signal. It is FALSE when the cable is unplugged, or the
+ boolean value is TRUE when the network cable is inserted, or there is
+ a carrier signal. It is FALSE when the cable is unplugged, or the
carrier signal is missing.
- name: DefaultGateway
type: string
@@ -104,9 +103,9 @@
- name: DefaultGateway6
type: string
description: >
- Default IPv6 gateway of the ethernet interface.
- For supported address formats refer RFC 2373.
- Refer below man page for both v4 and v6 address format details
+ Default IPv6 gateway of the ethernet interface. For supported address
+ formats refer RFC 2373. Refer below man page for both v4 and v6
+ address format details
https://man7.org/linux/man-pages/man3/inet_pton.3.html
errors:
- xyz.openbmc_project.Common.Error.InvalidArgument
@@ -124,15 +123,12 @@
- name: DHCPConf
description: >
- High level definitions of available DHCP states.
- These definitions do not have a 1:1 correlation to the
- systemd.network configuration file contents.
- both: Enable IPv4 DHCP and IPv6 Stateful DHCP
- v4v6stateless: Enable IPv4 DHCP and IPv6 SLAAC
- v6: Enable IPv6 Stateful DHCP
- v6stateless: Enable IPv6 SLAAC
- v4: Enable IPv4 DHCP
- none: Disable DHCP for IPv4 and IPv6
+ High level definitions of available DHCP states. These definitions do
+ not have a 1:1 correlation to the systemd.network configuration file
+ contents. both: Enable IPv4 DHCP and IPv6 Stateful DHCP v4v6stateless:
+ Enable IPv4 DHCP and IPv6 SLAAC v6: Enable IPv6 Stateful DHCP
+ v6stateless: Enable IPv6 SLAAC v4: Enable IPv4 DHCP none: Disable DHCP
+ for IPv4 and IPv6
values:
- name: both
- name: v4v6stateless
diff --git a/yaml/xyz/openbmc_project/Network/Experimental/Bond.interface.yaml b/yaml/xyz/openbmc_project/Network/Experimental/Bond.interface.yaml
index f0b3472..98d05c0 100644
--- a/yaml/xyz/openbmc_project/Network/Experimental/Bond.interface.yaml
+++ b/yaml/xyz/openbmc_project/Network/Experimental/Bond.interface.yaml
@@ -33,15 +33,16 @@
- name: RoundRobin
description: >
It is the default mode,in this mode system transmits packets in
- sequential order from the first available slave through the last.
+ sequential order from the first available slave through the
+ last.
- name: ActiveBackup
description: >
- In this mode, only one slave in the bond is active.
- The other one will become active, only when the active slave fails.
+ In this mode, only one slave in the bond is active. The other
+ one will become active, only when the active slave fails.
- name: XOR
description: >
- Transmit based on selectable hashing algorithm.
- The default policy is a simple source+destination MAC address algorithm.
+ Transmit based on selectable hashing algorithm. The default
+ policy is a simple source+destination MAC address algorithm.
- name: Broadcast
description: >
Transmits everything on all slave interfaces.
@@ -50,10 +51,12 @@
IEEE 802.3ad Dynamic link aggregation.
- name: TLB
description: >
- The outgoing traffic is distributed according to the current load on each slave.
+ The outgoing traffic is distributed according to the current
+ load on each slave.
- name: ALB
description: >
- Incoming/outgoing traffic is distributed according to the current load on each slave.
+ Incoming/outgoing traffic is distributed according to the
+ current load on each slave.
- name: HashPolicy
description: >
@@ -61,25 +64,25 @@
values:
- name: Layer2
description: >
- This policy uses XOR of hardware MAC addresses and packet type ID
- field to generate the hash.
+ This policy uses XOR of hardware MAC addresses and packet type
+ ID field to generate the hash.
- name: Layer2Plus3
description: >
- This policy uses a combination of layer2 and layer3
- protocol information to generate the hash.
+ This policy uses a combination of layer2 and layer3 protocol
+ information to generate the hash.
- name: Layer3Plus4
description: >
- This policy uses upper layer protocol information,
- when available, to generate the hash.
+ This policy uses upper layer protocol information, when
+ available, to generate the hash.
- name: Encap2Plus3
description: >
- This policy uses the same formula as layer2+3 but it
- relies on skb_flow_dissect to obtain the header fields
- which might result in the use of inner headers if an
- encapsulation protocol is used.
+ This policy uses the same formula as layer2+3 but it relies on
+ skb_flow_dissect to obtain the header fields which might result
+ in the use of inner headers if an encapsulation protocol is
+ used.
- name: Encap3Plus4
description: >
- This policy uses the same formula as layer3+4 but it
- relies on skb_flow_dissect to obtain the header fields
- which might result in the use of inner headers if an
- encapsulation protocol is used.
+ This policy uses the same formula as layer3+4 but it relies on
+ skb_flow_dissect to obtain the header fields which might result
+ in the use of inner headers if an encapsulation protocol is
+ used.
diff --git a/yaml/xyz/openbmc_project/Network/Experimental/Tunnel.interface.yaml b/yaml/xyz/openbmc_project/Network/Experimental/Tunnel.interface.yaml
index fe2bdae..a61be19 100644
--- a/yaml/xyz/openbmc_project/Network/Experimental/Tunnel.interface.yaml
+++ b/yaml/xyz/openbmc_project/Network/Experimental/Tunnel.interface.yaml
@@ -32,26 +32,25 @@
- name: IPv6FlowLabel
type: uint32
description: >
- Configures the 20-bit flow label. It can be configured to a value
- in the range 0–0xFFFFF, or be set to "inherit", in which case the
+ Configures the 20-bit flow label. It can be configured to a value in
+ the range 0–0xFFFFF, or be set to "inherit", in which case the
original flowlabel is used.
- name: CopyDSCP
type: boolean
description: >
- When true, the Differentiated Service Code Point
- (DSCP) field will be copied to the inner header from outer header
- during the decapsulation of an IPv6 tunnel packet.
+ When true, the Differentiated Service Code Point (DSCP) field will be
+ copied to the inner header from outer header during the decapsulation
+ of an IPv6 tunnel packet.
- name: EncapsulationLimit
type: uint32
description: >
- The Tunnel Encapsulation Limit option specifies how many
- additional levels of encapsulation are permitted to be prepended
- to the packet.
+ The Tunnel Encapsulation Limit option specifies how many additional
+ levels of encapsulation are permitted to be prepended to the packet.
- name: Key
type: string
description: >
- This parameter specifies the same key to use in both
- directions (InputKey= and OutputKey=).
+ This parameter specifies the same key to use in both directions
+ (InputKey= and OutputKey=).
- name: InputKey
type: string
description: >
diff --git a/yaml/xyz/openbmc_project/Network/IP.interface.yaml b/yaml/xyz/openbmc_project/Network/IP.interface.yaml
index 8a64533..eae2359 100644
--- a/yaml/xyz/openbmc_project/Network/IP.interface.yaml
+++ b/yaml/xyz/openbmc_project/Network/IP.interface.yaml
@@ -8,8 +8,8 @@
- name: Address
type: string
description: >
- The value of this property shall be an IP address assigned to
- the ethernet interface.
+ The value of this property shall be an IP address assigned to the
+ ethernet interface.
errors:
- xyz.openbmc_project.Common.Error.NotAllowed
diff --git a/yaml/xyz/openbmc_project/Network/MACAddress.interface.yaml b/yaml/xyz/openbmc_project/Network/MACAddress.interface.yaml
index 5ec8cd9..2df4676 100644
--- a/yaml/xyz/openbmc_project/Network/MACAddress.interface.yaml
+++ b/yaml/xyz/openbmc_project/Network/MACAddress.interface.yaml
@@ -5,9 +5,8 @@
- name: MACAddress
type: string
description: >
- MAC address of the ethernet interface in six groups of
- two hexadecimal digits separated by colons.
- Example: 01:23:45:67:89:AB
+ MAC address of the ethernet interface in six groups of two hexadecimal
+ digits separated by colons. Example: 01:23:45:67:89:AB
errors:
- xyz.openbmc_project.Common.Error.InvalidArgument
- xyz.openbmc_project.Common.Error.InternalFailure
diff --git a/yaml/xyz/openbmc_project/Network/README.md b/yaml/xyz/openbmc_project/Network/README.md
index 555bc49..eea7abf 100644
--- a/yaml/xyz/openbmc_project/Network/README.md
+++ b/yaml/xyz/openbmc_project/Network/README.md
@@ -2,18 +2,17 @@
## Overview
-A Network Manager is a daemon which handles network management operations.
-It must implement the
-`xyz.openbmc_project.Network.SystemConfiguration.interface` and
-`org.freedesktop.DBus.ObjectManager`.
+A Network Manager is a daemon which handles network management operations. It
+must implement the `xyz.openbmc_project.Network.SystemConfiguration.interface`
+and `org.freedesktop.DBus.ObjectManager`.
-When the network manager daemon comes up, it should create objects
-implementing physical link/virtual interfaces such as
+When the network manager daemon comes up, it should create objects implementing
+physical link/virtual interfaces such as
`xyz.openbmc_project.Network.EthernetInterface` or
`xyz.openbmc_project.Network.VLANInterface` on the system.
-IP address(v4 and v6) objects must be children objects of the
-physical/virtual interface object.
+IP address(v4 and v6) objects must be children objects of the physical/virtual
+interface object.
## Interfaces
@@ -30,15 +29,15 @@
Interface objects can be physical as well as virtual.
-If the object is a physical interface, it can't be deleted,
-but if it is a virtual interface object it can be deleted.
+If the object is a physical interface, it can't be deleted, but if it is a
+virtual interface object it can be deleted.
E.g. `/xyz/openbmc_project/network/<interfacename>`
### IP Address Objects
-There can be multiple IP address objects under an interface object.
-These objects can be deleted by the delete function.
+There can be multiple IP address objects under an interface object. These
+objects can be deleted by the delete function.
IPv4 objects will have the following D-Bus object path:
@@ -312,8 +311,8 @@
ipmitool -I dbus raw 0x06 0x40 // To the save settings
```
-NOTE: It takes 4-5 seconds to create the VLAN and configure the IP.
-If a VLAN interface is not desired don't set the VLAN id above.
+NOTE: It takes 4-5 seconds to create the VLAN and configure the IP. If a VLAN
+interface is not desired don't set the VLAN id above.
#### Delete