<!DOCTYPE html
PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html xmlns:jxb="http://java.sun.com/xml/ns/jaxb" xmlns:none="http://none"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>PlcmNetworkConfiguration.json</title><meta http-equiv="X-UA-Compatible" content="IE=7"><style type="text/css"><!--@import url("https://staged.poly.com/clariti2/apidocs/clariti-current/representations/book_conversion_apr2012.css");--></style><link rel="stylesheet" type="text/css" href="https://staged.poly.com/clariti2/apidocs/clariti-current/css/plcm-wadl-xsd.css"><!--
[if IE]>
<STYLE type="text/css">.altova-rotate-left-textbox{filter: progid:DXImageTransform.Microsoft.BasicImage(rotation=3)} .altova-rotate-right-textbox{filter: progid:DXImageTransform.Microsoft.BasicImage(rotation=1)} </STYLE>
<![endif]
--><!--[if !IE]><!--><style type="text/css">.altova-rotate-left-textbox{-webkit-transform: rotate(-90deg) translate(-100%, 0%); -webkit-transform-origin: 0% 0%;-moz-transform: rotate(-90deg) translate(-100%, 0%); -moz-transform-origin: 0% 0%;-ms-transform: rotate(-90deg) translate(-100%, 0%); -ms-transform-origin: 0% 0%;}.altova-rotate-right-textbox{-webkit-transform: rotate(90deg) translate(0%, -100%); -webkit-transform-origin: 0% 0%;-moz-transform: rotate(90deg) translate(0%, -100%); -moz-transform-origin: 0% 0%;-ms-transform: rotate(90deg) translate(0%, -100%); -ms-transform-origin: 0% 0%;}</style><!--<![endif]--><style type="text/css">@page { margin-left:0.60in; margin-right:0.60in; margin-top:0.79in; margin-bottom:0.79in } @media print { br.altova-page-break { page-break-before: always; } }</style></head><body><h1><span>PlcmNetworkConfiguration</span></h1><h4>
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.
</h4><dl style="margin-left: 18.000pt;"><dt><span><a name="plcm-network-configuration" href="plcm-network-configuration.json.htm#PlcmNetworkConfiguration">PlcmNetworkConfiguration</a></span></dt><dd><p>
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
</p></dd></dl><hr><h4><a name="PlcmNetworkConfiguration"><span>PlcmNetworkConfiguration Fields</span></a></h4><table style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; " rules="all"><thead style="background-color:#ccc; "><tr bgcolor="#d2d2d2"><th style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:2.50in; "><span>Name</span></th><th style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:3in; "><span>Type</span></th><th style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:4.50in; "><span>Description</span></th><th style="border-color:black; border-style:solid; border-width:1 px; width:4.50in; "><span>Attributes</span></th></tr></thead><tbody><tr style="top:auto; vertical-align:top; "><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:2.50in; "><span>atomLinkList </span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:3in; "><span>Array of </span><a href="https://staged.poly.com/clariti2/apidocs/clariti-current/representations/atom.json.htm#link">Link</a></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:4.50in; "><span>See Definition of </span><span>Link</span></td><td style="border-color:black; border-style:solid; border-width:1 px; width:4.50in; "></td></tr><tr style="top:auto; vertical-align:top; "><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:2.50in; "><span>hostTable</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:3in; "><span>Array of </span><a href="plcm-common.json.htm#PlcmHostsEntry">PlcmHostsEntry</a></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:4.50in; "></td><td style="border-color:black; border-style:solid; border-width:1 px; width:4.50in; "></td></tr><tr style="top:auto; vertical-align:top; "><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:2.50in; "><span>routingRules</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:3in; "><span>Array of </span><a href="plcm-network-rule.json.htm#PlcmNetworkRoutingRule">PlcmNetworkRoutingRule</a></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:4.50in; "></td><td style="border-color:black; border-style:solid; border-width:1 px; width:4.50in; "></td></tr><tr style="top:auto; vertical-align:top; "><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:2.50in; "><span>routeTables</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:3in; "><span>Array of </span><a href="plcm-network-route.json.htm#PlcmRouteTable">PlcmRouteTable</a></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:4.50in; "></td><td style="border-color:black; border-style:solid; border-width:1 px; width:4.50in; "></td></tr><tr style="top:auto; vertical-align:top; "><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:2.50in; "><span>plcmLoopbackInterface </span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:3in; "><a href="plcm-network-interface.json.htm#plcm-loopback-interface">PlcmLoopbackInterface</a></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:4.50in; "><span>See Definition of </span><span>PlcmLoopbackInterface</span></td><td style="border-color:black; border-style:solid; border-width:1 px; width:4.50in; "></td></tr><tr style="top:auto; vertical-align:top; "><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:2.50in; "><span>plcmBondInterfaceList </span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:3in; "><span>Array of </span><a href="plcm-network-interface.json.htm#plcm-bond-interface">PlcmBondInterface</a></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:4.50in; "><span>See Definition of </span><span>PlcmBondInterface</span></td><td style="border-color:black; border-style:solid; border-width:1 px; width:4.50in; "></td></tr><tr style="top:auto; vertical-align:top; "><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:2.50in; "><span>plcmEthernetInterfaceList </span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:3in; "><span>Array of </span><a href="plcm-network-interface.json.htm#plcm-ethernet-interface">PlcmEthernetInterface</a></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:4.50in; "><span>See Definition of </span><span>PlcmEthernetInterface</span></td><td style="border-color:black; border-style:solid; border-width:1 px; width:4.50in; "></td></tr><tr style="top:auto; vertical-align:top; "><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:2.50in; "><span>plcmDnsConfiguration </span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:3in; "><a href="plcm-network-dns.json.htm#plcm-dns-configuration">PlcmDnsConfiguration</a></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:4.50in; "><span>See Definition of </span><span>PlcmDnsConfiguration</span></td><td style="border-color:black; border-style:solid; border-width:1 px; width:4.50in; "></td></tr><tr style="top:auto; vertical-align:top; "><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:2.50in; "><span>physicalHostName</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:3in; "><a href="plcm-common.json.htm#PlcmDomainName">PlcmDomainName</a></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:4.50in; ">
Defines the physical host name for the server. This is not the fully
qualified domain name, only the hostname.
</td><td style="border-color:black; border-style:solid; border-width:1 px; width:4.50in; "><span>Mandatory</span></td></tr><tr style="top:auto; vertical-align:top; "><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:2.50in; "><span>physicalHostNameValueSource</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:3in; "><a href="plcm-network-configuration.json.htm#PhysicalHostNameValueSource">PhysicalHostNameValueSource</a></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:4.50in; ">
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
</td><td style="border-color:black; border-style:solid; border-width:1 px; width:4.50in; "></td></tr><tr style="top:auto; vertical-align:top; "><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:2.50in; "><span>dnsDomain</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:3in; "><a href="plcm-common.json.htm#PlcmDomainName">PlcmDomainName</a></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:4.50in; ">
Defines the DNS domain to which the server belongs.
</td><td style="border-color:black; border-style:solid; border-width:1 px; width:4.50in; "></td></tr><tr style="top:auto; vertical-align:top; "><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:2.50in; "><span>dnsDomainValueSource</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:3in; "><a href="plcm-network-configuration.json.htm#DnsDomainValueSource">DnsDomainValueSource</a></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:4.50in; ">
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
</td><td style="border-color:black; border-style:solid; border-width:1 px; width:4.50in; "></td></tr><tr style="top:auto; vertical-align:top; "><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:2.50in; "><span>defaultGateway</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:3in; "><a href="plcm-common.json.htm#PlcmInetAddress">PlcmInetAddress</a></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:4.50in; ">
Default gateway address for the server (ipv4)
</td><td style="border-color:black; border-style:solid; border-width:1 px; width:4.50in; "></td></tr><tr style="top:auto; vertical-align:top; "><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:2.50in; "><span>defaultGatewayIpv6</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:3in; "><a href="plcm-common.json.htm#PlcmInetAddress">PlcmInetAddress</a></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:4.50in; ">
Default gateway address for the server (ipv6)
</td><td style="border-color:black; border-style:solid; border-width:1 px; width:4.50in; "></td></tr><tr style="top:auto; vertical-align:top; "><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:2.50in; "><span>defaultGatewayDevice</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:3in; "><a href="plcm-network-configuration.json.htm#DefaultGatewayDevice">DefaultGatewayDevice</a></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:4.50in; ">
Default gateway device for the server (ipv4)
</td><td style="border-color:black; border-style:solid; border-width:1 px; width:4.50in; "></td></tr><tr style="top:auto; vertical-align:top; "><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:2.50in; "><span>edgeServicesEnabled</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:3in; "><span>boolean</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:4.50in; ">
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.
</td><td style="border-color:black; border-style:solid; border-width:1 px; width:4.50in; "></td></tr><tr style="top:auto; vertical-align:top; "><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:2.50in; "><span>enabledVersions</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:3in; "><span>Array of </span><a href="plcm-common.json.htm#PlcmIpVersion">PlcmIpVersion</a></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:4.50in; ">
The IP versions that are available to configure on the server
</td><td style="border-color:black; border-style:solid; border-width:1 px; width:4.50in; "></td></tr><tr style="top:auto; vertical-align:top; "><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:2.50in; "><span>networkingIpv4</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:3in; "><span>boolean</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:4.50in; ">
Indicates whether ipv4 network settings are inetended to be configured.
</td><td style="border-color:black; border-style:solid; border-width:1 px; width:4.50in; "></td></tr><tr style="top:auto; vertical-align:top; "><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:2.50in; "><span>networkingIpv6</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:3in; "><span>boolean</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:4.50in; ">
Indicates whether ipv6 network settings are inetended to be configured.
</td><td style="border-color:black; border-style:solid; border-width:1 px; width:4.50in; "></td></tr><tr style="top:auto; vertical-align:top; "><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:2.50in; "><span>entityTag</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:3in; "><a href="plcm-common.json.htm#EntityTag">EntityTag</a></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:4.50in; "></td><td style="border-color:black; border-style:solid; border-width:1 px; width:4.50in; "></td></tr></tbody></table><br><hr><h3><span>Nested Types/Restrictions</span></h3><br><table style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; " rules="all"><thead><tr bgcolor="#d2d2d2"><th style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:2.50in; "><span>Name</span></th><th style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:3in; "><span>Type</span></th><th style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:4.50in; "><span>Restrictions</span></th></tr></thead><tbody><tr style="top:auto; vertical-align:top; "><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:2.50in; "><a name="DefaultGatewayDevice"><span>DefaultGatewayDevice</span></a></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:3in; "><span>string</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:4.50in; "><br><span>Length of value must be >=</span><span>0</span><br><span>Length of value must be <=</span><span>64</span></td></tr><tr style="top:auto; vertical-align:top; "><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:2.50in; "><a name="DnsDomainValueSource"><span>DnsDomainValueSource</span></a></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:3in; "><span>string</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:4.50in; "><br><span>Length of value must be >=</span><span>0</span><br><span>Length of value must be <=</span><span>64</span></td></tr><tr style="top:auto; vertical-align:top; "><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:2.50in; "><a name="PhysicalHostNameValueSource"><span>PhysicalHostNameValueSource</span></a></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:3in; "><span>string</span></td><td style="border-collapse:collapse; border-color:black; border-style:solid; border-width:1px; width:4.50in; "><br><span>Length of value must be >=</span><span>0</span><br><span>Length of value must be <=</span><span>64</span></td></tr></tbody></table></body></html>