plcm-network-configuration.xsd Documentation

Definitions of the data structure for the entire set of network configuration options used on a single server. Note that a given set of configuration values will represent the options available for configuring the network using network configuration files or the options available for configuring the network using network configuration tools such as ip, ethtool, etc. but will not represent both.

Imported Namespaces

urn:com:polycom:api:rest:plcm-network
urn:com:polycom:api:rest:plcm-common
urn:com:polycom:api:rest:plcm-network-dns
urn:com:polycom:api:rest:plcm-network-address
urn:com:polycom:api:rest:plcm-network-route
urn:com:polycom:api:rest:plcm-network-rule
urn:com:polycom:api:rest:plcm-network-interface
http://www.w3.org/2005/Atom

Target Namespace

urn:com:polycom:api:rest:plcm-network-configuration

Elements

plcm-network-configuration PlcmNetworkConfiguration: Defines the network configuration. It can represent the live operational configuration or the configuration saved in the various network configuration files. Content-Types: application/vnd.plcm.plcm-network-configuration+xml application/vnd.plcm.plcm-network-configuration+json

Complex Types

PlcmNetworkConfiguration Fields

Name	Type	Description	Attributes
atomLinkList	List of link	See Definition of link
host-table	List of PlcmHostsEntry
routing-rules	List of PlcmNetworkRoutingRule
route-tables	List of PlcmRouteTable
plcm-loopback-interface	plcm-loopback-interface	See Definition of plcm-loopback-interface
plcmBondInterfaceList	List of plcm-bond-interface	See Definition of plcm-bond-interface
plcmEthernetInterfaceList	List of plcm-ethernet-interface	See Definition of plcm-ethernet-interface
plcm-dns-configuration	plcm-dns-configuration	See Definition of plcm-dns-configuration
physical-host-name	PlcmDomainName	Defines the physical host name for the server. This is not the fully qualified domain name, only the hostname.	Mandatory
physical-host-name-value-source	PhysicalHostNameValueSource	Specifies whether the physical host name in this configuration should override any values provided by a DHCP server. If the value is not present or is blank, the physical-host-name value in this configuration will override any DHCP supplied value. Otherwise, this field must specify the name of an interface that is configured with DHCP enabled and the value will be requested from the DHCP server associated with that interface
dns-domain	PlcmDomainName	Defines the DNS domain to which the server belongs.
dns-domain-value-source	DnsDomainValueSource	Specifies whether the DNS domain in this configuration should override any values provided by a DHCP server. If the value is not present or is blank, the dns-domain value in this configuration will override any DHCP supplied value. Otherwise, this field must specify the name of an interface that is configured with DHCP enabled and the value will be requested from the DHCP server associated with that interface
default-gateway	PlcmInetAddress	Default gateway address for the server (ipv4)
default-gateway-ipv6	PlcmInetAddress	Default gateway address for the server (ipv6)
default-gateway-device	DefaultGatewayDevice	Default gateway device for the server (ipv4)
edge-services-enabled	xs:boolean	Indicates whether network services associated with a system configured as an edge server are available for assignment to interfaces. True indicates that the services are available for configuration, false means only core services are available.
enabled-versions	List of PlcmIpVersion	The IP versions that are available to configure on the server
networking-ipv4	xs:boolean	Indicates whether ipv4 network settings are inetended to be configured.
networking-ipv6	xs:boolean	Indicates whether ipv6 network settings are inetended to be configured.
entity-tag	EntityTag

Simple Types

Name	Type	Restrictions
DefaultGatewayDevice	xs:string	Length of value must be >=0 Length of value must be <=64
DnsDomainValueSource	xs:string	Length of value must be >=0 Length of value must be <=64
PhysicalHostNameValueSource	xs:string	Length of value must be >=0 Length of value must be <=64