- Open Vulnerability and Assessment Language -
Element Dictionary

The following is a description of the elements, types, and attributes that compose the IOS-XE specific system characteristic items found in Open Vulnerability and Assessment Language (OVAL). Each item is an extension of the standard item element defined in the Core System Characteristic Schema. Through extension, each item inherits a set of elements and attributes that are shared amongst all OVAL Items. Each item is described in detail and should provide the information necessary to understand what each element and attribute represents. This document is intended for developers and assumes some familiarity with XML. A high level description of the interaction between the different tests and their relationship to the Core System Characteristic Schema is not outlined here.

The OVAL Schema is maintained by The MITRE Corporation and developed by the public OVAL Community. For more information, including how to get involved in the project and how to submit change requests, please visit the OVAL website at http://oval.mitre.org.

Thanks to Omar Santos and Panos Kampanakis of Cisco for providing this test.



< global_item >

Sotres information about the existence of a particular line in the IOS-XE config file under the global context

Extends: oval-sc:ItemType

Child Elements Type MinOccurs MaxOccurs
global_command oval-sc:EntityItemStringType 0 1
The global_command entity identifies a specific line in the IOS-XE config file under the global context.



< line_item >

Stores the properties of specific lines in the IOS-XE config file.

Extends: oval-sc:ItemType

Child Elements Type MinOccurs MaxOccurs
show_subcommand oval-sc:EntityItemStringType 0 1
The name of the SHOW sub-command.
config_line oval-sc:EntityItemStringType 0 1
The value returned from by the specified SHOW sub-command.



< version_item >

The version_item holds information about the version of the IOS-XE operating system. It extends the standard ItemType as defined in the oval-system-characteristics schema and one should refer to the ItemType description for more information.

Extends: oval-sc:ItemType

Child Elements Type MinOccurs MaxOccurs
platform oval-sc:EntityItemStringType 0 1
The platform entity specifies the platform that is running the IOS-XE software. For example if could be asr1000.
rp oval-sc:EntityItemIntType 0 1
The rp entity specifies the routing processor running the IOS-XE software.
pkg oval-sc:EntityItemStringType 0 1
The pkg entity specifies the consolidated IOS-XE packages in the image. For example it could be adventservicesk9.
major_release oval-sc:EntityItemIntType 0 1
The major_release entity specifies the major version piece of the version string. The value is an integer and in the example ASR1000rp1-ipbasek9.03.04.02.122-33.SR.bin the major_release is '03'.
release oval-sc:EntityItemIntType 0 1
The release entity specifies the release piece of the version string. The value is an integer and in the example ASR1000rp1-ipbasek9.03.04.02.122-33.SR.bin the release version is '04'
rebuild oval-sc:EntityItemIntType 0 1
The rebuild entity specifies the release piece of the version string. The value is an integer and in the example ASR1000rp1-ipbasek9.03.04.02.122-33.SR.bin the rebuild is '02'
ios_release oval-sc:EntityItemStringType 0 1
The ios_release entity specifies the IOS release the IOS-XE was derived from. The value is an string and in the example ASR1000rp1-ipbasek9.03.04.02.122-33.SR.bin the ios_release version is '122-33'
ios_train oval-sc:EntityItemStringType 0 1
The ios_train entity specifies the IOS release the IOS-XE was derived from. The value is an integer and in the example ASR1000rp1-ipbasek9.03.04.02.122-33.SR.bin the ios_release version is 'SR'



< section_item >

Stores command that are part of a IOS-XE configuration section. For example all configuration lines under an interface. It should not store configurations for configs that already have a separate item. For example BGP has a router item and should not also be stored in a section_item.

Extends: oval-sc:ItemType

Child Elements Type MinOccurs MaxOccurs
section_command oval-sc:EntityItemStringType 0 1
The name of the section command.
section_config_lines oval-sc:EntityItemStringType 0 1
Element with all config lines of the section
config_line oval-sc:EntityItemStringType 0 unbounded
Element with one config line of the section at a time



< interface_item >

The interface_item represents an IOS-XE interface and its configuration options.

Extends: oval-sc:ItemType

Child Elements Type MinOccurs MaxOccurs
name oval-sc:EntityItemStringType 0 1
Element with the interface name.
ip_directed_broadcast oval-sc:EntityItemBoolType 0 1
Element that is true if the directed broadcast command is enabled on the interface. The default is false.
proxy_arp oval-sc:EntityItemBoolType 0 1
Element that is true if the proxy_arp command is enabled on the interface. The default is true.
shutdown oval-sc:EntityItemBoolType 0 1
Element that is true if the interface is shut down. The default is false.
hardware_addr oval-sc:EntityItemStringType 0 1
Element with the interface hardware (MAC) address.
ipv4_address oval-sc:EntityItemIPAddressStringType 0 unbounded
Element with the interface IPv4 address and mask. This element should only allow 'ipv4_address' of the oval:SimpleDatatypeEnumeration.
ipv6_address oval-sc:EntityItemIPAddressStringType 0 unbounded
Element with the interface IPv6 address and mask. This element should only allow 'ipv6_address' of the oval:SimpleDatatypeEnumeration.
ipv4_access_list oval-sc:EntityItemStringType 0 2
Element with the ingress or egress IPv4 ACL name applied on the interface.
ipv6_access_list oval-sc:EntityItemStringType 0 2
Element with the ingress or egress IPv6 ACL name applied on the interface.
crypto_map oval-sc:EntityItemStringType 0 1
Element with the crypto map name applied to the interface.
urpf_command oval-sc:EntityItemStringType 0 1
Element with the uRPF command under the interface.
switchport_trunk_encapsulation iosxe-sc:EntityItemTrunkEncapType 0 1
Element with the switchport trunk encapsulation option configured on the interface (if applicable).
switchport_mode iosxe-sc:EntityItemSwitchportModeType 0 1
Element with the switchport mode option configured on the interface (if applicable).
switchport_native_vlan oval-sc:EntityItemStringType 0 1
Element with the trunk native vlan configured on the interface (if applicable).
switchport_access_vlan oval-sc:EntityItemIntType 0 1
Element with the access vlan configured on the interface (if applicable).
switchport_trunked_vlans oval-sc:EntityItemStringType 0 1
Element with the vlans that are trunked configured on the interface (if applicable).
switchport_pruned_vlans oval-sc:EntityItemStringType 0 1
Element with the vlans that are pruned from the trunk (if applicable).
switchport_port_security oval-sc:EntityItemStringType 0 1
Element with the switchport port-security commands configured on the interface (if applicable).



< router_item >

Stores commands that are part of a IOS-XE 'router' command configuration. For example 'router bgp 123'.

Extends: oval-sc:ItemType

Child Elements Type MinOccurs MaxOccurs
protocol iosxe-sc:EntityItemRoutingProtocolType 0 1
Element with the routing protocol.
id oval-sc:EntityItemIntType 0 1
Element with the IOS-XE router id.
network oval-sc:EntityItemStringType 0 unbounded
Element with the subnet in the network command of the router instance. The area can be included in the string for OSPF.
bgp_neighbor oval-sc:EntityItemStringType 0 unbounded
Element with the BGP neighbors, if applicable.
ospf_authentication_area oval-sc:EntityItemIntType 0 unbounded
Element with the OSPF area that is authenticated, if applicable.
router_config_lines oval-sc:EntityItemStringType 0 1
Element with all config lines of the router.



< bgpneighbor_item >

Stores information about bgp neighbors configured in bgp instances.

Extends: oval-sc:ItemType

Child Elements Type MinOccurs MaxOccurs
neighbor oval-sc:EntityItemStringType 0 1
Element with the bgp neighbor.
password oval-sc:EntityItemStringType 0 1
Element with the bgp authentication password, if configured. If Encryption type is configured it should be included in the password string. For example '0 cisco123'.



< routingprotocolauthintf_item >

Stores information for routing protocol authentication configured under specific interfaces.

Extends: oval-sc:ItemType

Child Elements Type MinOccurs MaxOccurs
interface oval-sc:EntityItemStringType 0 1
Element with the interface.
protocol iosxe-sc:EntityItemRoutingProtocolType 0 unbounded
Element with the routing protocol.
id oval-sc:EntityItemIntType 0 1
Element with the routing protocol id.
auth_type iosxe-sc:EntityItemRoutingAuthTypeStringType 0 1
Element with the routing protocol authentication type.
ospf_area oval-sc:EntityItemIntType 0 1
Element with the OSPF area that is authenticated, if applicable.
key_chain oval-sc:EntityItemStringType 0 1
Element with the name of the key chain, if applicable.



< acl_item >

Stores command that are part of a IOS-XE configuration section. For example all configuration lines under an interface. It should not store configurations for configs that already have a separate item. For example BGP has a router item and should not also be stored in a acl_item.

Extends: oval-sc:ItemType

Child Elements Type MinOccurs MaxOccurs
name oval-sc:EntityItemStringType 0 1
Element with the name of the ACL.
ip_version iosxe-sc:EntityItemAccessListIPVersionType 0 1
Element with the IP version of the ACL.
use iosxe-sc:EntityItemAccessListUseType 0 1
Element with the feature where the ACL is used. If the same ACL is applied in more than one feature (i.e interface and crypto map), multiple items needs to be created.
used_in oval-sc:EntityItemStringType 0 1
Element with the name of where the ACL is used. For example if use is 'INTERFACE', use_in will be the name of the interface. If the same ACL is applied in more than one feature (i.e interface and crypto map), multiple items needs to be created.
interface_direction iosxe-sc:EntityItemAccessListInterfaceDirectionType 0 1
Element with the direction the ACL is applied on an interface.
acl_config_lines oval-sc:EntityItemStringType 0 1
Element with the value returned with all config lines of the ACL.
config_line oval-sc:EntityItemStringType 0 1
Element with the value returned with one ACL config line at a time.



< snmphost_item >

Stores information about the SNMP host configuration in IOS. That information includes the host, the community or user strings, the SNMP version, the snmp security (if the SNMP version is SNMPv3) and the SNMP traps.

Extends: oval-sc:ItemType

Child Elements Type MinOccurs MaxOccurs
host oval-sc:EntityItemStringType 0 1
Element with the SNMP host address or hostname.
community_or_user oval-sc:EntityItemStringType 0 1
Element with the community string or SNMPv3 user configured for the host.
version iosxe-sc:EntityItemSNMPVersionStringType 0 1
Element with the SNMP version.
snmpv3_sec_level iosxe-sc:EntityItemSNMPSecLevelStringType 0 1
Element with the SNMPv3 security configure for the host.
traps oval-sc:EntityItemStringType 0 1
Element with the SNMP traps configured.



< snmpcommunity_item >

Stores information about an SNMP community configuration in IOS. That information includes the community name, the view (if it applies) name, the read-write mode and the ACLs names applied.

Extends: oval-sc:ItemType

Child Elements Type MinOccurs MaxOccurs
name oval-sc:EntityItemStringType 0 1
Element with the SNMP community name.
view oval-sc:EntityItemStringType 0 1
Element with the view that restricts the OIDs of this community.
mode iosxe-sc:EntityItemSNMPModeStringType 0 1
Element with the read-write privileges of the community.
ipv4_acl oval-sc:EntityItemStringType 0 1
Element with the IPv4 ACL name applied to the community.
ipv6_acl oval-sc:EntityItemStringType 0 1
Element with the IPv6 ACL name applied to the community



< snmpuser_item >

Stores information about an SNMP user configuration in IOS. That information includes the user name, the SNMP group he belongs to, the SNMP version, the IPv4 or IPv6 ACL it is applied to, the Security Level and the Authentication type that apply to the user (for SNMPv3).

Extends: oval-sc:ItemType

Child Elements Type MinOccurs MaxOccurs
name oval-sc:EntityItemStringType 0 1
Element with the SNMP user name.
group oval-sc:EntityItemStringType 0 1
Element with the SNMP group the user belongs to.
version iosxe-sc:EntityItemSNMPVersionStringType 0 1
Element with the SNMP version of the user.
ipv4_acl oval-sc:EntityItemStringType 0 1
Element with the IPv4 ACL name applied to the user.
ipv6_acl oval-sc:EntityItemStringType 0 1
Element with the IPv6 ACL name applied to the user.
priv iosxe-sc:EntityItemSNMPPrivStringType 0 1
Element with the SNMP encryption type for the user (for SNMPv3).
auth iosxe-sc:EntityItemSNMPAuthStringType 0 1
Element with the SNMP authentication type for the user (for SNMPv3).



< snmpgroup_item >

Stores information about an SNMP group configuration in IOS. That information includes the group name, the SNMP version, the IPv4 or IPv6 ACL it is applied toand the read, write and/or notify views applied to the group.

Extends: oval-sc:ItemType

Child Elements Type MinOccurs MaxOccurs
name oval-sc:EntityItemStringType 0 1
Element with the SNMP group name.
version iosxe-sc:EntityItemSNMPVersionStringType 0 1
Element with the SNMP version of the group.
snmpv3_sec_level iosxe-sc:EntityItemSNMPSecLevelStringType 0 1
Element with the SNMPv3 security configure for the group.
ipv4_acl oval-sc:EntityItemStringType 0 1
Element with the IPv4 ACL name applied to the group.
ipv6_acl oval-sc:EntityItemStringType 0 1
Element with the IPv6 ACL name applied to the group.
read_view oval-sc:EntityItemStringType 0 1
Element with the SNMP read view applied to the group.
write_view oval-sc:EntityItemStringType 0 1
Element with the SNMP write view applied to the group.
notify_view oval-sc:EntityItemStringType 0 1
Element with the SNMP notify view applied to the group.



< snmpview_item >

Stores information about an SNMP view configuration in IOS. That information includes the view name, the mib_family that the view uses and the included or excluded option of the mib family in the view.

Extends: oval-sc:ItemType

Child Elements Type MinOccurs MaxOccurs
name oval-sc:EntityItemStringType 0 1
Element with the SNMP view name.
mib_family oval-sc:EntityItemStringType 0 1
Element with the SNMP MIB family of the view.
include oval-sc:EntityItemBoolType 0 1
Element that is true if the included option is used in the view.

== EntityItemTrunkEncapType ==

The EntityItemTrunkEncapType complex type restricts a string value to a specific set of values: DOT1Q, ISL, NEGOTIATE. These values describe the interface trunk encapsulation types on an interfaces in IOS. The empty string is also allowed to support empty element associated with error conditions.

Restricts: oval-sc:EntityItemStringType

Value Description

DOT1Q 

 

ISL 

 

NEGOTIATE 

 

 

The empty string value is permitted here to allow for empty elements associated with error conditions.


== EntityItemSwitchportModeType ==

The EntityObjectRoutingProtocolType complex type restricts a string value to a specific set of values: DYNAMIC, TRUNK, ACCESS. These values describe the interface switchport mode types in IOS. The empty string is also allowed to support empty element associated with error conditions.

Restricts: oval-sc:EntityItemStringType

Value Description

DYNAMIC 

 

TRUNK 

 

ACCESS 

 

 

The empty string value is permitted here to allow for empty elements associated with error conditions.


== EntityItemRoutingProtocolType ==

The EntityItemRoutingProtocolType complex type restricts a string value to a specific set of values: EIGRP, OSPF, BGP, RIP, RIPV2, ISIS. These values describe the routing protocol used in a Cisco IOS-XE configuration. The empty string is also allowed to support empty element associated with error conditions.

Restricts: oval-sc:EntityItemStringType

Value Description

EIGRP 

 

OSPF 

 

BGP 

 

RIP 

 

RIPV2 

 

ISIS 

 

 

The empty string value is permitted here to allow for empty elements associated with error conditions.


== EntityItemRoutingAuthTypeStringType ==

The EntityItemRoutingAuthTypeStringType complex type restricts a string value to a specific set of values: CLEARTEXT, MESSAGE_DIGEST, NULL. These values describe the routing protocol authentication types used in a Cisco IOS-XE configuration. The empty string is also allowed to support empty element associated with error conditions.

Restricts: oval-sc:EntityItemStringType

Value Description

CLEARTEXT 

 

MESSAGE_DIGEST 

 

NULL 

 

 

The empty string value is permitted here to allow for empty elements associated with error conditions.


== EntityItemSNMPVersionStringType ==

The EntityItemSNMPVersionStringType complex type restricts a string value to a specific set of values: 1, 2c, 3. These values describe the SNMP version in a Cisco IOS-XE configuration. The empty string is also allowed to support empty element associated with error conditions.

Restricts: oval-sc:EntityItemStringType

Value Description

 

2C 

 

 

 

The empty string value is permitted here to allow for empty elements associated with error conditions.


== EntityItemSNMPSecLevelStringType ==

The EntityItemSNMPVersionStringType complex type restricts a string value to a specific set of values: PRIV, AUTH, NO_AUTH. These values describe the SNMP security level (encryption, Authentication, None) in a Cisco IOS-XE SNMPv3 related configurations. The empty string is also allowed to support empty element associated with error conditions.

Restricts: oval-sc:EntityItemStringType

Value Description

PRIV 

 

AUTH 

 

NO_AUTH 

 

 

The empty string value is permitted here to allow for empty elements associated with error conditions.


== EntityItemSNMPModeStringType ==

The EntityItemSNMPModeStringType complex type restricts a string value to a specific set of values: RO, RW. These values describe the SNMP mode (read-only, read-write) in a Cisco IOS-XE SNMPv3 related configurations. The empty string is also allowed to support empty element associated with error conditions.

Restricts: oval-sc:EntityItemStringType

Value Description

RO 

 

RW 

 

 

The empty string value is permitted here to allow for empty elements associated with error conditions.


== EntityItemSNMPAuthStringType ==

The EntityItemSNMPAuthStringType complex type restricts a string value to a specific set of values: MD5, SHA. These values describe the authentication algorithm in a Cisco IOS-XE SNMPv3 related configurations. The empty string is also allowed to support empty element associated with error conditions.

Restricts: oval-sc:EntityItemStringType

Value Description

MD5 

 

SHA 

 

 

The empty string value is permitted here to allow for empty elements associated with error conditions.


== EntityItemSNMPPrivStringType ==

The EntityItemSNMPPrivStringType complex type restricts a string value to a specific set of values: DES, 3DES, AES. These values describe the encryption algorithm in a Cisco IOS-XE SNMPv3 related configurations. The empty string is also allowed to support empty element associated with error conditions.

Restricts: oval-sc:EntityItemStringType

Value Description

DES 

 

3DES 

 

AES 

 

 

The empty string value is permitted here to allow for empty elements associated with error conditions.


== EntityItemAccessListIPVersionType ==

The EntityItemRoutingProtocolType complex type restricts a string value to a specific set of values: IPV4, IPV6. These values describe if an ACL is for IPv4 or IPv6 in a Cisco IOS-XE configuration. The empty string is also allowed to support empty element associated with error conditions.

Restricts: oval-sc:EntityItemStringType

Value Description

IPV4 

 

IPV6 

 

 

The empty string value is permitted here to allow for empty elements associated with error conditions.


== EntityItemAccessListUseType ==

The EntityItemAccessListUseType complex type restricts a string value to a specific set of values: INTERFACE, CRYPTO_MAP_MATCH, CLASS_MAP_MATCH, ROUTE_MAP_MATCH, IGMP_FILTER, NONE. These values describe the ACL use in a Cisco IOS-XE configuration. The empty string is also allowed to support empty element associated with error conditions.

Restricts: oval-sc:EntityItemStringType

Value Description

INTERFACE 

 

CRYPTO_MAP_MATCH 

 

CLASS_MAP_MATCH 

 

ROUTE_MAP_MATCH 

 

IGMP_FILTER 

 

NONE 

 

 

The empty string value is permitted here to allow for empty elements associated with error conditions.


== EntityItemAccessListInterfaceDirectionType ==

The EntityItemAccessListInterfaceDirectionType complex type restricts a string value to a specific set of values: IN, OUT. These values describe the inbound or outbound ACL direction on an interface in a Cisco IOS-XE configuration. The empty string is also allowed to support empty element associated with error conditions.

Restricts: oval-sc:EntityItemStringType

Value Description

IN 

 

OUT 

 

 

The empty string value is permitted here to allow for empty elements associated with error conditions.