pp_lexicon.xml

<?xml version='1.0' standalone='yes'?>
<?xml-stylesheet type="text/xsl" href="/pp_lexicon.xsl"?>
<!--
# Copyright 2011-2013 Proofpoint, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#  http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
-->
<pp_lexicon version="1.2.1">
    <!-- These are the top level inventory API objects -->
    <entities>
        <vip key="comkey">
            <name>
                <label>VIP Name</label>
                <flavor>config</flavor>
                <required>true</required>
                <format>string</format>
            </name>
            <ipaddress>
                <label>Destination</label>
                <flavor>config</flavor>
                <required>false</required>
                <format>string</format>
            </ipaddress>
            <pool>
                <label>Pool</label>
                <flavor>config</flavor>
                <required>true</required>
                <format>string</format>
            </pool>
            <lb_fqdn refers_to="/pp_lexicon/entities/system">
                <label>Load Balancer</label>
                <flavor>config</flavor>
                <required>false</required>
                <format>string</format>
            </lb_fqdn>
            <vlans>
                <label>VLANS</label>
                <flavor>config</flavor>
                <required>false</required>
                <format>string</format>
            </vlans>
            <status>
                <label>Status</label>
                <flavor>config</flavor>
                <required>false</required>
                <format>string</format>
            </status>
            <comkey>
                <label>Lookup</label>
                <flavor>config</flavor>
                <required>true</required>
                <format>string</format>
            </comkey>
            <config>
                <label>Config</label>
                <flavor>config</flavor>
                <required>false</required>
                <format>string</format>
            </config>
        </vip>
        <pool key="comkey">
            <name>
                <label>Name</label>
                <flavor>config</flavor>
                <required>false</required>
                <format>string</format>
            </name>
            <members>
                <label>Members</label>
                <flavor>config</flavor>
                <required>false</required>
                <format>string</format>
            </members>
            <status>
                <label>Status</label>
                <flavor>config</flavor>
                <required>false</required>
                <format>string</format>
            </status>
            <lb_fqdn refers_to="/pp_lexicon/entities/system">
                <label>Load Balancer</label>
                <flavor>config</flavor>
                <required>false</required>
                <format>string</format>
            </lb_fqdn>
            <monitor>
                <label>Monitor</label>
                <flavor>config</flavor>
                <required>false</required>
                <format>string</format>
            </monitor>
            <comkey>
                <label>Lookup</label>
                <flavor>config</flavor>
                <required>true</required>
                <format>string</format>
            </comkey>
            <config>
                <label>Config</label>
                <flavor>config</flavor>
                <required>false</required>
                <format>string</format>
            </config>
        </pool>
        <snat key="comkey">
            <name>
                <label>Name</label>
                <flavor>config</flavor>
                <required>false</required>
                <format>string</format>
            </name>
            <origins>
                <label>Origins</label>
                <flavor>config</flavor>
                <required>false</required>
                <format>string</format>
            </origins>
            <lb_fqdn refers_to="/pp_lexicon/entities/system">
                <label>Load Balancer</label>
                <flavor>config</flavor>
                <required>false</required>
                <format>string</format>
            </lb_fqdn>
            <status>
                <label>Status</label>
                <flavor>config</flavor>
                <required>false</required>
                <format>string</format>
            </status>
            <vlans>
                <label>VLANS</label>
                <flavor>config</flavor>
                <required>false</required>
                <format>string</format>
            </vlans>
            <comkey>
                <label>Lookup</label>
                <flavor>config</flavor>
                <required>true</required>
                <format>string</format>
            </comkey>
            <config>
                <label>Config</label>
                <flavor>config</flavor>
                <required>false</required>
                <format>string</format>
            </config>
        </snat>
        <data_center key="data_center_code" field_order="data_center_code,data_center_vendor,data_center_city,data_center_country,data_center_telephone">
            <data_center_code>
                <label>Datacenter</label>
                <required>true</required>
                <format>string</format>
                <!--                 <validation><member_of>../enumeration</member_of></validation>-->
            </data_center_code>
            <data_center_vendor label="Vendor"/>
            <data_center_city label="City"/>
            <data_center_country label="Country"/>
            <data_center_phone label="Phone"/>
        </data_center>
        <datacenter_subnet label="DataCenter" key="id" field_order="id,subnet,ipv6_subnet,data_center_code,nodes,az_id">
            <id>
                <label>ID</label>
                <flavor>config</flavor>
                <format>string</format>
                <required>true</required>
            </id>
            <subnet>
                <label>Subnet</label>
                <flavor>config</flavor>
                <format>string</format>
                <required>true</required>
            </subnet>
            <gateway>
                <label>Gateway</label>
                <flavor>config</flavor>
                <format>string</format>
                <required>false</required>
            </gateway>
            <vlan>
                <label>VLAN</label>
                <flavor>config</flavor>
                <format>string</format>
                <required>false</required>
            </vlan>
            <data_center_code flavor="config" maps_to="/pp_lexicon/entities/data_center/data_center_code" required="false"/>
            <notes>
                <label>Notes</label>
                <flavor>config</flavor>
                <format>text</format>
                <required>false</required>
            </notes>
        </datacenter_subnet>
        <rack key="rack_code">
            <data_center_code maps_to="/pp_lexicon/entities/data_center/data_center_code" required="true"/>
            <cage_code maps_to="/pp_lexicon/entities/cage/cage_code" required="true"/>
            <rack_code maps_to="/pp_lexicon/data_elements/string" required="false"/>
        </rack>
        <service_instance key="svc_id" field_order="svc_id,name,type,note,environment_name">
            <svc_id label="SVC ID" maps_to="/pp_lexicon/data_elements/int" required="true"/>
            <name label="SVC Name" maps_to="/pp_lexicon/data_elements/string" required="true"/>
            <type label="Type" maps_to="/pp_lexicon/data_elements/string" required="false"/>
            <note label="Note" maps_to="/pp_lexicon/data_elements/string" required="false"/>
            <environment_name field_category="main" label="Environment" maps_to="/pp_lexicon/data_elements/string" required="false">
            <enumeration attribute="name" entity="environments"/> 
            </environment_name>
        </service_instance>
        <service_instance_data key="data_id">
            <data_id label="Data ID" maps_to="/pp_lexicon/data_elements/int" required="true"/>
            <svc_id label="SVC ID" maps_to="/pp_lexicon/data_elements/int" required="true"/>
            <data_key label="Key" maps_to="/pp_lexicon/data_elements/string" required="true"/>
            <data_value label="Value" maps_to="/pp_lexicon/data_elements/string" required="true"/>
        </service_instance_data>
        <device key="fqdn">
            <fqdn field_category="main" required="true">
                <label>Name</label>
                <flavor>config</flavor>
                <format>string</format>
                <fact>fqdn</fact>
            </fqdn>
            <inventory_component_type field_category="main" required="true">
                <label>Type</label>
                <flavor>config</flavor>
                <format>string</format>
                <enumeration>
                    <enumerator>blade_chassis</enumerator>
                    <enumerator>console_server</enumerator>
                    <enumerator>firewall</enumerator>
                    <enumerator>load_balancer</enumerator>
                    <enumerator>network_switch</enumerator>
                    <enumerator>other</enumerator>
                    <enumerator>power_strip</enumerator>
                    <enumerator>router</enumerator>
                    <enumerator>rsa_appliance</enumerator>
                    <enumerator>storage_head</enumerator>
                    <enumerator>storage_shelf</enumerator>
                    <enumerator>system</enumerator>
                    <enumerator>vpn</enumerator>
                </enumeration>
                <validation>
                    <is_string/>
                </validation>
            </inventory_component_type>
            <serial_number field_category="HW Info" >
                <label>Serial</label>
                <!-- <flavor>fact</flavor> -->
                <format>string</format>
                <fact>serial_number</fact>
            </serial_number>
            <system_type required="false">
                <label>Business</label>
                <flavor>config</flavor>
                <format>string</format>
                <enumeration>
                    <enumerator>POD</enumerator>
                    <enumerator>Archiving</enumerator>
                    <enumerator>Core</enumerator>
                    <enumerator>EDN</enumerator>
                    <enumerator>Eng</enumerator>
                </enumeration>
                <validation>
                    <is_string/>
                </validation>
            </system_type>
            <ipaddress field_category="main" required="true">
                <label>IP Address</label>
                <!-- <flavor>fact</flavor>-->
                <format>string</format>
                <validation>
                    <regex>/.*/</regex>
                </validation>
                <fact>betterip,ipaddress,ip_address</fact>
            </ipaddress>
            <macaddress required="true">
                <label>MAC Address</label>
                <flavor>fact</flavor>
                <format>string</format>
                <validation>
                    <regex>/.*/</regex>
                </validation>
            </macaddress>
            <data_center_code>
                <label>Datacenter</label>
                <flavor>fact</flavor>
                <required>true</required>
                <format>string</format>
                <enumeration attribute="data_center_code" entity="data_center"/>
                <!--                 <validation><member_of>../enumeration</member_of></validation>-->
            </data_center_code>
            <cage_code  field_category="HW Info" maps_to="/pp_lexicon/entities/cage/cage_code" required="false">
                <label>Cage</label>
            </cage_code>
            <rack_code  field_category="HW Info" maps_to="/pp_lexicon/entities/rack/rack_code" required="false">
                <label>Rack</label>
            </rack_code>
            <rack_position field_category="HW Info" >
                <label>Rack Position</label>
                <flavor>config</flavor>
                <format>string</format>
                <validation>
                    <is_int/>
                    <less_than_or_equal_to>42</less_than_or_equal_to>
                </validation>
            </rack_position>
            <manufacturer field_category="HW Info" >
                <label>Manufacturer</label>
                <!-- <flavor>fact</flavor>-->
                <format>string</format>
                <fact>manufacturer</fact>
                <enumeration attribute="manufacturer" entity="system"/>
            </manufacturer>
            <productname field_category="HW Info" >
                <label>Product</label>
                <!-- <flavor>fact</flavor>-->
                <format>string</format>
                <fact>productname</fact>
                <enumeration attribute="productname" entity="system"/>
            </productname>
            <created_by label="Created by" maps_to="/pp_lexicon/data_elements/string" required="false"/>
            <date_created label="Created at" required="false" type="date"/>
            <date_modified label="Modified at" required="false" type="date"/>
            <agent_reported flavor="fact" meta="true" required="false" type="date">
                <label>Agent Reported</label>
            </agent_reported>
            <status field_category="main" >
                <label>Status</label>
                <required>false</required>
                <flavor>config</flavor>
                <format>string</format>
                <enumeration>
                    <enumerator>production</enumerator>
                    <enumerator>deployment</enumerator>
                    <enumerator>allocated</enumerator>
                    <enumerator>idle</enumerator>
                    <enumerator>in transit</enumerator>
                    <enumerator>degraded</enumerator>
                    <enumerator>decommissioned</enumerator>
                    <enumerator>disposed</enumerator>
                </enumeration>
                <validation>
                    <is_string/>
                </validation>
            </status>
        </device>
        <system extends="/pp_lexicon/entities/device" key="fqdn" field_order="fqdn,status,inventory_component_type,roles,ipaddress,environment_name,svc_id,notes">
            <svc_id field_category="main" label="Service Record" maps_to="/pp_lexicon/data_elements/int" required="false">
                <enumeration attribute="name" entity="service_instance"/>
            </svc_id>
            <ipmi_ip label="IPMI Address" field_category="HW Info" />
            <hardware_class field_category="HW Info" label="Class" required="false">
                <enumeration attribute="hardware_class" entity="hardware_model"/>
            </hardware_class>
            <agent_type flavor="fact" label="Agent Type" maps_to="/pp_lexicon/data_elements/string" required="false"/>
            <drac_version  field_category="HW Info" maps_to="/pp_lexicon/data_elements/string" required="false">
                <label>Drac Version</label>
            </drac_version>
            <drac_macaddress  field_category="HW Info" maps_to="/pp_lexicon/data_elements/string" required="false">
                <label>Drac MacAddress</label>
            </drac_macaddress>
            <bios_version  field_category="HW Info" flavor="fact" maps_to="/pp_lexicon/data_elements/string" required="false">
                <label>Bios Version</label>
            </bios_version>
            <bios_vendor  field_category="HW Info" flavor="fact" maps_to="/pp_lexicon/data_elements/string" required="false">
                <label>Bios Vendor</label>
            </bios_vendor>
            <raidtype  field_category="HW Info" flavor="fact" maps_to="/pp_lexicon/data_elements/string" required="false">
                <label>Raid Type</label>
            </raidtype>
            <raiddrives  field_category="HW Info" flavor="fact" maps_to="/pp_lexicon/data_elements/string" required="false">
                <label>Raid Drives</label>
            </raiddrives>
            <raidcontroller  field_category="HW Info" flavor="fact" maps_to="/pp_lexicon/data_elements/string" required="false">
                <label>Raid Controller</label>
            </raidcontroller>
            <raidvolumes  field_category="HW Info" flavor="fact" maps_to="/pp_lexicon/data_elements/string" required="false">
                <label>Raid Volumes</label>
            </raidvolumes>
            <raiddrivestatus  field_category="HW Info" flavor="fact" maps_to="/pp_lexicon/data_elements/string" required="false">
                <label>Raid Drive Status</label>
            </raiddrivestatus>
            <raidbaddrives  field_category="HW Info" flavor="fact" maps_to="/pp_lexicon/data_elements/string" required="false">
                <label>Raid Bad Drives</label>
            </raidbaddrives>
            <notes format="text" field_category="main" maps_to="/pp_lexicon/data_elements/string" required="false">
                <label>Notes</label>
            </notes>
            <tags maps_to="/pp_lexicon/data_elements/string" required="false">
                <label>JSON Tags</label>
            </tags>
            <warranty_info  field_category="HW Info" format="text" maps_to="/pp_lexicon/data_elements/string" required="false">
                <label>Warranty Info</label>
            </warranty_info>
            <asset_tag_number field_category="HW Info" >
                <label>Asset Tag</label>
                <flavor>config</flavor>
                <format>string</format>
            </asset_tag_number>
            <disk_drive_count field_category="HW Info"  maps_to="/pp_lexicon/data_elements/int" required="false">
                <label>Drive Count</label>
            </disk_drive_count>
            <file_systems type="array">
                <label>File Systems</label>
                <file_system maps_to="/pp_lexicon/entities/file_system"/>
            </file_systems>
            <physical_processor_count  field_category="HW Info" maps_to="/pp_lexicon/data_elements/string" required="false">
                <label>Processor Count</label>
            </physical_processor_count>
            <memorysize  field_category="HW Info" maps_to="/pp_lexicon/data_elements/string" required="false">
                <label>Memory</label>
        <flavor>fact</flavor>
            </memorysize>
            <ipv6address maps_to="/pp_lexicon/data_elements/string" required="false">
                <label>IPv6 Address</label>
            </ipv6address>
            <virtual flavor="fact" maps_to="/pp_lexicon/data_elements/string" required="false">
                <label>VM Type</label>
            </virtual>
            <operatingsystem>
                <label>OS</label>
                <flavor>config</flavor>
                <format>string</format>
                <fact>operatingsystem</fact>
                <enumeration attribute="operating_system" entity="system"/>
            </operatingsystem>
            <operatingsystemrelease>
                <label>OS Release</label>
                <flavor>config</flavor>
                <format>string</format>
                <fact>operatingsystemrelease</fact>
            </operatingsystemrelease>
            <kernelrelease>
                <label>Kernel Release</label>
                <flavor>fact</flavor>
                <format>string</format>
                <fact>kernelrelease</fact>
            </kernelrelease>
            <interfaces  field_category="HW Info" flavor="fact">
                <label>NICs</label>
                <required>false</required>
                <format>string</format>
            </interfaces>
            <netdriver field_category="HW Info" >
                <label>Netdriver</label>
                <flavor>fact</flavor>
                <format>string</format>
            </netdriver>
            <netdriver_version field_category="HW Info" >
                <label>Netdriver Version</label>
                <flavor>fact</flavor>
                <format>string</format>
            </netdriver_version>
            <netdriver_firmware field_category="HW Info" >
                <label>Netdriver Firmware</label>
                <flavor>fact</flavor>
                <format>string</format>
            </netdriver_firmware>
            <netdriver_speed field_category="HW Info" >
                <label>Netdriver Speed</label>
                <flavor>fact</flavor>
                <format>string</format>
            </netdriver_speed>
            <netdriver_duplex field_category="HW Info" >
                <label>Netdriver Duplex</label>
                <flavor>fact</flavor>
                <format>string</format>
            </netdriver_duplex>
            <drac  field_category="HW Info" maps_to="/pp_lexicon/entities/drac" required="false">
                <label>DRAC</label>
            </drac>
            <roles field_category="main" >
                <label>Roles</label>
                <format>multiselect</format>
                <enumeration attribute="role_id" entity="role"/>
            </roles>
            <role_version label="Role Version" field_catetory="main" fact="notestore_version" />
            <customers type="array">
                <label>Customers</label>
                <customer maps_to="/pp_lexicon/entities/customer"/>
            </customers>
            <power_supply_watts field_category="HW Info" >
                <label>Power Supply(Watts)</label>
                <flavor>fact</flavor>
                <format>float</format>
                <validation>
                    <is_float/>
                </validation>
            </power_supply_watts>
            <power_consumption_avg field_category="HW Info" >
                <label>Average Power Consumption(Watts)</label>
                <flavor>fact</flavor>
                <format>int</format>
                <validation>
                    <is_int/>
                </validation>
            </power_consumption_avg>
            <power_consumption_peak field_category="HW Info" >
                <label>Peak Power Consumption(Watts)</label>
                <flavor>fact</flavor>
                <format>int</format>
                <validation>
                    <is_int/>
                </validation>
            </power_consumption_peak>
            <power_consumption_peak_time field_category="HW Info" >
                <label>Time of Peak Power (Unix Timestamp, UTC)</label>
                <flavor>fact</flavor>
                <format>int_timestamp</format>
            </power_consumption_peak_time>
            <is_virtual label="Virtual" maps_to="/pp_lexicon/data_elements/bool" required="false"/>
            <guest_fqdns type="array">
                <label>Guest Hosts</label>
                <fqdn maps_to="/pp_lexicon/data_elements/fqdn" required="false"/>
            </guest_fqdns>
            <!-- This attribute is only meaningful if this system is a guest (VM/blades) -->
            <host_fqdn maps_to="/pp_lexicon/data_elements/fqdn" required="false">
                <label>Parent Host</label>
            </host_fqdn>
            <audit_info>
                <label>Phys Audit</label>
                <required>false</required>
                <flavor>config</flavor>
                <format>string</format>
            </audit_info>
            <environment_name field_category="main" label="Environment" maps_to="/pp_lexicon/data_elements/string" required="false">
            <enumeration attribute="name" entity="environments"/>
            </environment_name>

            <config_agent_timestamp field_category="Puppet" label="Puppet Timestamp" meta="true" required="false" type="date"/>
            <config_agent_status  field_category="Puppet" label="Puppet Status" maps_to="/pp_lexicon/data_elements/string" meta="true" required="false"/>
            <config_agent_summary  field_category="Puppet" label="Puppet Summary" maps_to="/pp_lexicon/data_elements/string" meta="true" required="false"/>
            <config_agent_output  field_category="Puppet" format="text" label="Puppet Output" maps_to="/pp_lexicon/data_elements/string" meta="true" required="false"/>
            <size label="Instance Size" maps_to="/pp_lexicon/data_elements/string" meta="true" required="false"/>
            <image label="System Image" maps_to="/pp_lexicon/data_elements/string" meta="true" required="false"/>
            <cloud label="Cloud" maps_to="/pp_lexicon/data_elements/string" meta="true" required="false"/>
        </system>
        <blade_chassis extends="/pp_lexicon/entities/device" key="fqdn">
            <guest_fqdns type="array">
                <fqdn maps_to="/pp_lexicon/data_elements/fqdn" required="true"/>
            </guest_fqdns>
        </blade_chassis>
        <role key="role_id" field_order="role_id,role_name">
            <role_id format="string" label="Role" required="true" />
            <role_name maps_to="/pp_lexicon/data_elements/string" required="true">
                <label>Description</label>
            </role_name>
        </role>
        <inv_normalizer key="id" field_order="id,entity_name,field_name,matcher,sub_value">
            <id>
                <label>ID</label>
                <required>true</required>
                <format>int</format>
            </id>
            <entity_name>
                <label>Entity</label>
                <required>true</required>
                <format>string</format>
            </entity_name>
            <field_name>
                <label>Field</label>
                <required>true</required>
                <format>string</format>
            </field_name>
            <matcher>
                <label>Regex Matcher</label>
                <required>true</required>
                <format>string</format>
            </matcher>
            <sub_value>
                <label>Substitute Value</label>
                <required>true</required>
                <format>string</format>
            </sub_value>
        </inv_normalizer>
        <acl key="acl_id" field_order="acl_id,acl_group,entity,field,logic">
            <acl_id format="int" label="ID"/>
            <acl_group format="string" label="Group"/>
            <entity format="string" label="Entity"/>
            <field format="string" label="Field"/>
            <logic format="string" label="Block Logic"/>
        </acl>
        <user key="username" field_order="username,systemuser,groups,writeaccess,sshkey">
            <username format="string" label="Username"/>
            <writeaccess format="bool" label="Write Access"/>
            <systemuser format="bool" label="System User"/>
            <sshkey format="text" label="SSH Key"/>
            <groups format="array" label="Groups">
                <enumeration>
                    <enumerator>OPS</enumerator>
                    <enumerator>IT</enumerator>
                    <enumerator>QA</enumerator>
                </enumeration>
            </groups>
        </user>
        <change_queue key="id">
            <id format="string" label="ID"/>
            <change_ip format="string" label="IP Address"/>
            <change_user format="string" label="User"/>
            <change_time format="string" label="Time"/>
            <entity format="string" label="Entity"/>
            <entity_key format="string" label="Key"/>
            <change_content format="string" label="Change"/>
        </change_queue>
        <inv_audit key="entity_key">
            <change_ip format="string" label="IP Address"/>
            <change_user format="string" label="User"/>
            <change_time format="string" label="Time"/>
            <entity_name format="string" label="Entity"/>
            <entity_key format="string" label="Key"/>
            <field_name format="string" label="Field"/>
            <old_value format="string" label="Old Value"/>
            <new_value format="string" label="New Value"/>
        </inv_audit>
        <hardware_model key="hardware_class">
            <manufacturer>
                <label>Manufacturer</label>
                <format>string</format>
            </manufacturer>
            <product_name>
                <label>Product</label>
                <format>string</format>
            </product_name>
            <hardware_class label="HW Class" maps_to="/pp_lexicon/data_elements/product_variant" required="false"/>
            <power_supply_count label="Pwr Supply Count" maps_to="/pp_lexicon/data_elements/power_supply_count" required="false"/>
            <power_supply_watts>
                <label>Power Supply(Watts)</label>
                <format>float</format>
                <validation>
                    <is_float/>
                </validation>
            </power_supply_watts>
            <size>
                <label>Size (RU)</label>
                <format>int</format>
                <required>false</required>
            </size>
        </hardware_model>
        <environments key="name">
            <name label="Name" maps_to="/pp_lexicon/data_elements/string" required="true"/>
            <environment_name field_category="main" label="Parent Environment" maps_to="/pp_lexicon/data_elements/string" required="true">
            <enumeration attribute="name" entity="environments"/> 
            </environment_name>
            <note label="Note" maps_to="/pp_lexicon/data_elements/string" required="false"/>
        </environments>
        <environmentservice key="name" field_order="name,type,note,environment_name">
            <name label="SVC Name" maps_to="/pp_lexicon/data_elements/string" required="true"/>
            <type label="Type" maps_to="/pp_lexicon/data_elements/string" required="false"/>
            <note label="Note" maps_to="/pp_lexicon/data_elements/string" required="false"/>
            <environment_name field_category="main" label="Environment" maps_to="/pp_lexicon/data_elements/string" required="false">
                <enumeration attribute="name" entity="environments"/> 
            </environment_name>
        </environmentservice>

    </entities>
</pp_lexicon>