LXI Device Specific Configuration Schema

The LXI Device Specific Configuration represents device-specific or automatically configured network settings of the device network interface. If the device configuration enables automatic configuration, such as DHCP, any configuration specified in the LXI Device Specific Configuration Schema may be superseded.

RULE: Devices shall retain the LXI Device Specific configuration and only utilize it when automatic configuration is disabled. Thus, writing the LXI Device Specific Configuration while automatic configuration is active then disabling automatic configuration will result in the device using the configuration specified in LXI Device Specific Configuration.

Reading the LXI Device Specific Configuration from the device always returns the current settings of the interface over which it is read, regardless of if the settings were statically configured or received from automatic configuration.

To determine if automatic configuration is enabled read the LXI Common Configuration.

This schema specifies the XML namespace:

http://lxistandard.org/schemas/LXIDeviceSpecificConfiguration/1.0, version: 1.0
Editorial date: September 28, 2023

LXIDeviceSpecificConfiguration

LXIDeviceSpecificConfiguration contains various settings associated with the network interface that are potentially device specific.

For details on the various settings, see the LXI Device specification.

Attributes

Attribute

Syntax

LCI

Description

name

Type:	xs:string
Card.:	Opt.
Default:	None

name indicates the name of the interface described by this document.

name is required on a GET and shall indicate the name used for the interface in the LXICommonConfiguration Interface/@name attribute. Devices with a single interface shall use the name "LXI".

name is optional on a PUT. If absent, the interface over which this XML is delivered is configured.

OBSERVATION: providing the LXICommonConfiguration Interface/@name here permits the client to associate the device specific IP configuration with the configuration in the LXICommonConfiguration.

Required: RULE:

Unsecure impact: NA

Sub-elements

The following must occur in this order:

Element	Type	Cardinality	Requirements
IPv4Device	lxi:IPv4Device	Optional	IPv4Device contains the device-specific configuration related to IPv4. RULE: LXI Devices shall accept IPv4Device. RULE: If IPv4Device is absent, and the LXI Common Configuration does not specify automatic configuration, the IPv4 capability is disabled.
IPv6Device	lxi:IPv6Device	Optional	IPv6Device contains the device-specific configuration related to IPv6. RULE: LXI Devices shall accept IPv6Device RULE: If IPv6Device is absent, and the LXI Common Configuration does not specify any automatic configuration, the IPv6 capability is disabled.
Any element	Any type	Optional unbounded	Extension elements may be use to provide arbitrary interface configuration.

Element

Type

Cardinality

Requirements

IPv4Device

lxi:IPv4Device

Optional

IPv4Device contains the device-specific configuration related to IPv4.

RULE: LXI Devices shall accept IPv4Device.

RULE: If IPv4Device is absent, and the LXI Common Configuration does not specify automatic configuration, the IPv4 capability is disabled.

IPv6Device

lxi:IPv6Device

Optional

IPv6Device contains the device-specific configuration related to IPv6.

RULE: LXI Devices shall accept IPv6Device

RULE: If IPv6Device is absent, and the LXI Common Configuration does not specify any automatic configuration, the IPv6 capability is disabled.

Any element

Any type

Optional unbounded

Extension elements may be use to provide arbitrary interface configuration.

IPv4Device

IPv4Device represents the device-specific state of the IP version 4 capabilities of the device that are potentially device-specific.

When IPv4Device is written, the point in time at which it takes affect is device dependent.

Attributes

Attribute

Syntax

LCI

Description

address

Type:	xs:string
Card.:	Opt.
Default:	None

No change

address contains the IPv4 address of the device.

Required: RULE:

Unsecure impact: Any

subnetMask

Type:	xs:string
Card.:	Opt.
Default:	None

No change

subnetMask contains the subnet mask to use.

Required: RULE:

Unsecure impact: any

gateway

Type:	xs:string
Card.:	Opt.
Default:	None

No change

gateway contains the gateway address.

Required: RULE:

Unsecure impact: any

dns1

Type:	xs:string
Card.:	Opt.
Default:	None

No change

dns1 is the address of the first DNS server.

Required: RULE:

Unsecure impact: any

dns2

Type:	xs:string
Card.:	Opt.
Default:	None

No change

dns2 is the address of the second (alternate) DNS server.

Required: RULE:

Unsecure impact: any

Any Attribute

Type:	Any type
Card.:	Optional
Default:	NA

Arbitrary extension attributes may be included to provide device-specific IPv4 configuration that is beyond the scope of the LXI requirements.

RULE: LXI devices shall ignore extension attributes they do not recognize.

Required: No

Unsecure impact: NA

The IPv4Device complex type has no subelements

IPv6Device

IPv6Device represents the device-specific state of the IP version 6 capabilities of the device that are potentially device-specific.

When IPv6Device is written, the point in time at which it takes affect is device dependent.

Attributes

Attribute

Syntax

LCI

Description

Any Attribute

Type:	Any type
Card.:	Optional
Default:	NA

Arbitrary extension attributes may be included to provide device-specific IPv6 configuration that is beyond the scope of the LXI requirements.

RULE: LXI devices shall ignore extension attributes they do not recognize.

Required: No

Unsecure impact: NA

Sub-elements

The following must occur in this order:

Element	Type	Cardinality	Requirements
StaticAddress	lxi:IPv6Address	Optional unbounded	StaticAddress is optional and contains the device static address. OBSERVATION: If the LXICommonConfiguration/Network/IPv6/@staticAddressEnabled is false, the static addresses are not used. RULE: Devices shall accept at least one StaticAddress.
LinkLocalAddress	lxi:IPv6Address	Optional	LinkLocalAddress is a read-only field that contains the devices current link local address. RULE: LXI Devices shall include the link local address in responses.
GlobalAddress	lxi:IPv6Address	Optional unbounded	GlobalAddress is a read-only element that contains the addresses provided to the device via router advertisement or DHCP. RULE: A GlobalAddress element shall be included in the response for every device global address. OBSERVATION: Since unique-local may be determined by router advertisement or stateful DHCPv6 it is returned using a GlobalAddress element.

Element

Type

Cardinality

Requirements

StaticAddress

lxi:IPv6Address

Optional unbounded

StaticAddress is optional and contains the device static address.

OBSERVATION: If the LXICommonConfiguration/Network/IPv6/@staticAddressEnabled is false, the static addresses are not used.

RULE: Devices shall accept at least one StaticAddress.

LinkLocalAddress

lxi:IPv6Address

Optional

LinkLocalAddress is a read-only field that contains the devices current link local address.

RULE: LXI Devices shall include the link local address in responses.

GlobalAddress

lxi:IPv6Address

Optional unbounded

GlobalAddress is a read-only element that contains the addresses provided to the device via router advertisement or DHCP.

RULE: A GlobalAddress element shall be included in the response for every device global address.

OBSERVATION: Since unique-local may be determined by router advertisement or stateful DHCPv6 it is returned using a GlobalAddress element.

IPv6Address

IPv6Address contains an IPv6 address.

Attributes

Attribute

Syntax

LCI

Description

address

Type:	xs:string
Card.:	Req.
Default:	NA

address contains the IPv6 address in CIDR notation.

Required: RULE:

Unsecure impact: NA

router

Type:	xs:string
Card.:	Opt.
Default:	None

router contains the router IPv6 address if this IPv6Address has an associated router. The address is in CIDR notation.

Required: RULE:

Unsecure impact: NA

dns

Type:	xs:string
Card.:	Opt.
Default:	None

dns contains the address of the IPv6 domain name server if this IPv6Address has an associated dns. The address is in CIDR notation.

Required: RULE:

Unsecure impact: NA

The IPv6Address complex type has no subelements