Open Vulnerability and Assessment Language: IOS-XE Definition

  • Schema: IOS-XE Definition
  • Version: 5.11.1:1.2
  • Release Date: 11/30/2016 09:00:00 AM

The following is a description of the elements, types, and attributes that compose the IOS-XE specific tests found in Open Vulnerability and Assessment Language (OVAL). Each test is an extension of the standard test element defined in the Core Definition Schema. Through extension, each test inherits a set of elements and attributes that are shared amongst all OVAL tests. Each test 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 Definition Schema is not outlined here.

The OVAL Schema is maintained by the 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.cisecurity.org.

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

< global_test >

The global test is used to check for the existence of a particular line in the IOS-XE config file under the global context. It extends the standard TestType as defined in the oval-definitions-schema and one should refer to the TestType description for more information. The required object element references a global_object and the optional state element specifies the data to check.

Extends: oval-def:TestType

Child Elements

Elements
Child Elements Type (MinOccurs..MaxOccurs) Desc.
object oval-def:ObjectRefType (1..1)  
state oval-def:StateRefType (0..unbounded)  

< global_object >

The global_object element is used by a global test to define the object to be evaluated. For the most part this object checks for existence and is used without a state comparision. Each object extends the standard ObjectType as defined in the oval-definitions-schema and one should refer to the ObjectType description for more information. The common set element allows complex objects to be created using filters and set logic. Again, please refer to the description of the set element in the oval-definitions-schema.

Extends: oval-def:ObjectType

Child Elements

Elements
Child Elements Type (MinOccurs..MaxOccurs) Desc.
global_command oval-def:EntityObjectStringType (1..1) The global_command entity identifies a specific line in the IOS-XE config file under the global context.
oval-def:filter n/a (0..unbounded)  

< global_state >

The global_state element defines the different information that can be found in the IOS-XE config file under the global context. Please refer to the individual elements in the schema for more details about what each represents.

Extends: oval-def:StateType

Child Elements

Elements
Child Elements Type (MinOccurs..MaxOccurs) Desc.
global_command oval-def:EntityStateStringType (0..1) The global_command entity identifies a specific line in the IOS-XE config file under the global context.

< line_test >

The line test is used to check the properties of specific output lines from a SHOW command, such as show running-config. It extends the standard TestType as defined in the oval-definitions-schema and one should refer to the TestType description for more information. The required object element references a line_object and the optional state element specifies the data to check.

Extends: oval-def:TestType

Child Elements

Elements
Child Elements Type (MinOccurs..MaxOccurs) Desc.
object oval-def:ObjectRefType (1..1)  
state oval-def:StateRefType (0..unbounded)  

< line_object >

The line_object element is used by a line test to define the object to be evaluated. Each object extends the standard ObjectType as defined in the oval-definitions-schema and one should refer to the ObjectType description for more information. The common set element allows complex objects to be created using filters and set logic. Again, please refer to the description of the set element in the oval-definitions-schema.

A line object consists of a show_subcommand entity that is the name of a SHOW sub-command to be tested.

Extends: oval-def:ObjectType

Child Elements

Elements
Child Elements Type (MinOccurs..MaxOccurs) Desc.
show_subcommand oval-def:EntityObjectStringType (1..1) The name of a SHOW sub-command.
oval-def:filter n/a (0..unbounded)  

< line_state >

The line_state element defines the different information that can be used to evaluate the result of a specific SHOW sub-command. This includes the name of ths sub-command and the corresponding config line. Please refer to the individual elements in the schema for more details about what each represents.

Extends: oval-def:StateType

Child Elements

Elements
Child Elements Type (MinOccurs..MaxOccurs) Desc.
show_subcommand oval-def:EntityStateStringType (0..1) The name of the SHOW sub-command.
config_line oval-def:EntityStateStringType (0..1) The value returned from by the specified SHOW sub-command.

< version_test >

The version_test is used to check the version of the IOS-XE operating system. It extends the standard TestType as defined in the oval-definitions-schema and one should refer to the TestType description for more information. The required object element references a version_object and the optional state element specifies the data to check.

Extends: oval-def:TestType

Child Elements

Elements
Child Elements Type (MinOccurs..MaxOccurs) Desc.
object oval-def:ObjectRefType (1..1)  
state oval-def:StateRefType (0..unbounded)  

< version_object >

The version_object element is used by a version_test to define the different version information associated with an IOS-XE system. There is actually only one object relating to version and this is the system as a whole. Therefore, there are no child entities defined. Any OVAL Test written to check version will reference the same version_object which is basically an empty object element.

Extends: oval-def:ObjectType

< version_state >

The version_state element defines the version information held within a Cisco IOS-XE Train. A Cisco IOS-XE train is a vehicle for delivering releases that evolve from a common code base.

Extends: oval-def:StateType

Child Elements

Elements
Child Elements Type (MinOccurs..MaxOccurs) Desc.
platform (Deprecated) oval-def:EntityStateStringType (0..1) The platform that is running the IOS-XE software. For example if could be asr1000.
rp (Deprecated) oval-def:EntityStateIntType (0..1) The routing processor running the IOS-XE software.
pkg (Deprecated) oval-def:EntityStateStringType (0..1) The consolidated IOS-XE packages in the image. For example it could be adventservicesk9.
version_string oval-def:EntityStateStringType (0..1) The entire IOS-XE version string, for example, ‘03.13.02.S’.
major_release oval-def:EntityStateIntType (0..1) The major version piece of the version string. The value is an integer, and in the example 03.13.02.S the major_release is ‘3’
release oval-def:EntityStateIntType (0..1) The minor release piece of the version string. The value is an integer, and in the example 03.13.02.S the release is ‘13’
rebuild oval-def:EntityStateIntType (0..1) The rebuild piece of the version string. The value is an integer, and in the example 03.13.02.S the rebuild is ‘2’
train oval-def:EntityStateStringType (0..1) The train piece of the version string. The value is a string, and in the example 03.13.02.S the train is ‘S’
ios_release (Deprecated) oval-def:EntityStateStringType (0..1) The IOS release the IOS-XE was derived from. The value is a string and in the example ASR1000rp1-ipbasek9.03.04.02.122-33.SR.bin the ios_release version is ‘122-33’
ios_train (Deprecated) oval-def:EntityStateStringType (0..1) 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’

< interface_test >

The interface test is used to check for the existence of a particular interface on the Cisco IOS-XE device. It extends the standard TestType as defined in the oval-definitions-schema and one should refer to the TestType description for more information. The required object element references a interface_object and the optional state element specifies the data to check.

Extends: oval-def:TestType

Child Elements

Elements
Child Elements Type (MinOccurs..MaxOccurs) Desc.
object oval-def:ObjectRefType (1..1)  
state oval-def:StateRefType (0..unbounded)  

< interface_object >

The interface_object element is used by an interface_test to define the object to be evaluated. Each object extends the standard ObjectType as defined in the oval-definitions-schema and one should refer to the ObjectType description for more information. The common set element allows complex objects to be created using filters and set logic. Again, please refer to the description of the set element in the oval-definitions-schema.

An interface_object consists of a name entity that is the name of the IOS-XE interface to be tested.

Extends: oval-def:ObjectType

Child Elements

Elements
Child Elements Type (MinOccurs..MaxOccurs) Desc.
name oval-def:EntityObjectStringType (1..1) The interface name.
oval-def:filter n/a (0..unbounded)  

< interface_state >

The interface_state element defines the different information that can be used to evaluate the result of a specific IOS-XE interface. This includes the name, status, and address information about the interface. Please refer to the individual elements in the schema for more details about what each represents.

Extends: oval-def:StateType

Child Elements

Elements
Child Elements Type (MinOccurs..MaxOccurs) Desc.
name oval-def:EntityStateStringType (0..1) The interface name.
ip_directed_broadcast oval-def:EntityStateBoolType (0..1) Directed broadcast command enabled on the interface. The default is false.
proxy_arp oval-def:EntityStateBoolType (0..1) Proxy arp enabled on the interface. The default is true.
shutdown oval-def:EntityStateBoolType (0..1) Interface is shut down.
hardware_addr oval-def:EntityStateStringType (0..1) The interface hardware (MAC) address.
ipv4_address oval-def:EntityStateIPAddressStringType (0..1) The interface IPv4 address and mask. This element should only allow ‘ipv4_address’ of the oval:SimpleDatatypeEnumeration.
ipv6_address oval-def:EntityStateIPAddressStringType (0..1) The interface IPv6 address and mask. This element should only allow ‘ipv6_address’ of the oval:SimpleDatatypeEnumeration.
ipv4_access_list oval-def:EntityStateStringType (0..1) The ingress or egress IPv4 ACL name applied on the interface.
ipv6_access_list oval-def:EntityStateStringType (0..1) The ingress or egress IPv6 ACL name applied on the interface.
crypto_map oval-def:EntityStateStringType (0..1) The crypto map name applied to the interface.
ipv4_urpf_command oval-def:EntityStateStringType (0..1) The IPv4 uRPF command under the interface.
ipv6_urpf_command oval-def:EntityStateStringType (0..1) The IPv6 uRPF command under the interface.
urpf_command (Deprecated) oval-def:EntityStateStringType (0..1) The uRPF command under the interface.
switchport_trunk_encapsulation iosxe-def:EntityStateTrunkEncapType (0..1) The switchport trunk encapsulation option configured on the interface (if applicable).
switchport_mode iosxe-def:EntityStateSwitchportModeType (0..1) The switchport mode option configured on the interface (if applicable).
switchport_native_vlan Restriction of oval-def:EntityStateAnySimpleType. See schema for details. (0..1) The trunk native vlan configured on the interface (if applicable).
switchport_access_vlan Restriction of oval-def:EntityStateAnySimpleType. See schema for details. (0..1) The access vlan configured on the interface (if applicable).
switchport_trunked_vlans oval-def:EntityStateStringType (0..1) The vlans that are trunked configured on the interface (if applicable).
switchport_pruned_vlans oval-def:EntityStateStringType (0..1) The vlans that are pruned from the trunk (if applicable).
switchport_port_security oval-def:EntityStateStringType (0..1) The switchport port-security commands configured on the interface (if applicable).

< section_test >

The section test is used to check the properties of specific output lines from a configuration section.

Extends: oval-def:TestType

Child Elements

Elements
Child Elements Type (MinOccurs..MaxOccurs) Desc.
object oval-def:ObjectRefType (1..1)  
state oval-def:StateRefType (0..unbounded)  

< section_object >

The section_object element is used by a section test to define the object to be evaluated. Each object extends the standard ObjectType as defined in the oval-definitions-schema and one should refer to the ObjectType description for more information. The common set element allows complex objects to be created using filters and set logic. Again, please refer to the description of the set element in the oval-definitions-schema.

A section object consists of a section_command entity that is the name of a section command to be tested.

Extends: oval-def:ObjectType

Child Elements

Elements
Child Elements Type (MinOccurs..MaxOccurs) Desc.
section_command oval-def:EntityObjectStringType (1..1) The name of a section command.
oval-def:filter n/a (0..unbounded)  

< section_state >

The section_state element defines the different information that can be used to evaluate the result of a specific section command. This includes the name of ths section_command and the corresponding config lines. Please refer to the individual elements in the schema for more details about what each represents.

Extends: oval-def:StateType

Child Elements

Elements
Child Elements Type (MinOccurs..MaxOccurs) Desc.
section_command oval-def:EntityStateStringType (0..1) The name of the section command.
section_config_lines oval-def:EntityStateStringType (0..1) The value returned with all config lines of the section.
config_line oval-def:EntityStateStringType (0..1) The value returned with one config line of the section at a time.

< router_test >

The router test is used to check the properties of specific output lines from a router configurated instance in IOS-XE.

Extends: oval-def:TestType

Child Elements

Elements
Child Elements Type (MinOccurs..MaxOccurs) Desc.
object oval-def:ObjectRefType (1..1)  
state oval-def:StateRefType (0..unbounded)  

< router_object >

The router_object element is used by a router test to define the object to be evaluated. Each object extends the standard ObjectType as defined in the oval-definitions-schema and one should refer to the ObjectType description for more information. The common set element allows complex objects to be created using filters and set logic. Again, please refer to the description of the set element in the oval-definitions-schema.

A router object consists of a router protocol and router identifier entity.

Extends: oval-def:ObjectType

Child Elements

Elements
Child Elements Type (MinOccurs..MaxOccurs) Desc.
protocol iosxe-def:EntityObjectRoutingProtocolType (1..1) The routing protocol of the router instance.
id oval-def:EntityObjectIntType (1..1) The IOS-XE router id.
oval-def:filter n/a (0..unbounded)  

< router_state >

The router_state element defines the different information that can be used to evaluate the result of a specific router command. This includes the protocol of the router instance, the id, the networks, bgp neighbor, ospf authentication area commands and the corresponding config lines. Please refer to the individual elements in the schema for more details about what each represents.

Extends: oval-def:StateType

Child Elements

Elements
Child Elements Type (MinOccurs..MaxOccurs) Desc.
protocol iosxe-def:EntityStateRoutingProtocolType (1..1) The routing protocol of the router instance. If there are more than one router configurations, for example ospf instances, different objects should be created for each.
id oval-def:EntityStateIntType (0..1) The IOS-XE router id
network oval-def:EntityStateStringType (0..1) The subnet in the network command of the router instance. The area can be included in the string for OSPF.
bgp_neighbor oval-def:EntityStateStringType (0..1) The BGP neighbors, if applicable.
ospf_authentication_area Restriction of oval-def:EntityStateAnySimpleType. See schema for details. (0..1) The OSPF area that is authenticated, if applicable.
router_config_lines oval-def:EntityStateStringType (0..1) The value returned with all config lines of the router instance.

< bgpneighbor_test >

The bgpneighbor test is used to check the bgp neighbpr properties of bgp instances instances in IOS.

Extends: oval-def:TestType

Child Elements

Elements
Child Elements Type (MinOccurs..MaxOccurs) Desc.
object oval-def:ObjectRefType (1..1)  
state oval-def:StateRefType (0..unbounded)  

< bgpneighbor_object >

The bgpneighbor_object element is used by a bgpneighbor test to define the object to be evaluated. Each object extends the standard ObjectType as defined in the oval-definitions-schema and one should refer to the ObjectType description for more information. The common set element allows complex objects to be created using filters and set logic. Again, please refer to the description of the set element in the oval-definitions-schema.

A bgpneighbor object consists of a neighbor entity.

Extends: oval-def:ObjectType

Child Elements

Elements
Child Elements Type (MinOccurs..MaxOccurs) Desc.
neighbor oval-def:EntityObjectStringType (1..1) The bgp neighbor.
oval-def:filter n/a (0..unbounded)  

< bgpneighbor_state >

The bgpneighbor_state element defines the different information that can be used to evaluate the result of a bgp neighbor configuration. This includes the neighbor and the password option, if configured. Please refer to the individual elements in the schema for more details about what each represents.

Extends: oval-def:StateType

Child Elements

Elements
Child Elements Type (MinOccurs..MaxOccurs) Desc.
neighbor oval-def:EntityStateStringType (0..1) The bgp neighbor.
password oval-def:EntityStateStringType (0..1) The bgp authentication password, if configured. If Encryption type is configured it should be included in the password string. For example ‘0 cisco123’.

< routingprotocolauthintf_test >

The routing protocol authentication interface test is used to check the properties of routing protocol authentication configured under interfaces in IOS.

Extends: oval-def:TestType

Child Elements

Elements
Child Elements Type (MinOccurs..MaxOccurs) Desc.
object oval-def:ObjectRefType (1..1)  
state oval-def:StateRefType (0..unbounded)  

< routingprotocolauthintf_object >

The routingprotocolauthintf_object element is used by a routingprotocolauthintf test to define the object to be evaluated. Each object extends the standard ObjectType as defined in the oval-definitions-schema and one should refer to the ObjectType description for more information. The common set element allows complex objects to be created using filters and set logic. Again, please refer to the description of the set element in the oval-definitions-schema.

A routingprotocolauthintf object consists of an interface and the routing protocol that is authenticated entity.

Extends: oval-def:ObjectType

Child Elements

Elements
Child Elements Type (MinOccurs..MaxOccurs) Desc.
interface oval-def:EntityObjectStringType (1..1) The interface name.
protocol iosxe-def:EntityObjectRoutingProtocolType (1..1) The routing protocol.
oval-def:filter n/a (0..unbounded)  

< routingprotocolauthintf_state >

The routingprotocolauthintf_state element defines the different information that can be used to evaluate the result of a specific routing protocol interface authentication configurations. This includes the interface, the protocol, the id, the authentication type, the ospf area, the key chain command and the corresponding config lines. Please refer to the individual elements in the schema for more details about what each represents.

Extends: oval-def:StateType

Child Elements

Elements
Child Elements Type (MinOccurs..MaxOccurs) Desc.
interface oval-def:EntityStateStringType (0..1) The interface name.
protocol iosxe-def:EntityStateRoutingProtocolType (0..1) The routing protocol.
id oval-def:EntityStateIntType (0..1) The routing protocol id, if applicable.
auth_type iosxe-def:EntityStateRoutingAuthTypeStringType (0..1) The routing protocol authentication type.
ospf_area Restriction of oval-def:EntityStateAnySimpleType. See schema for details. (0..1) The OSPF area that is authenticated, if applicable.
key_chain oval-def:EntityStateStringType (0..1) The name of the key chain, if applicable.

< acl_test >

The acl test is used to check the properties of specific output lines from an ACL configuration.

Extends: oval-def:TestType

Child Elements

Elements
Child Elements Type (MinOccurs..MaxOccurs) Desc.
object oval-def:ObjectRefType (1..1)  
state oval-def:StateRefType (0..unbounded)  

< acl_object >

The acl_object element is used by an acl test to define the object to be evaluated. Each object extends the standard ObjectType as defined in the oval-definitions-schema and one should refer to the ObjectType description for more information. The common set element allows complex objects to be created using filters and set logic. Again, please refer to the description of the set element in the oval-definitions-schema.

An acl object consists of a an acl name and an IP version entity that is the name and the IP protocol version of the access-list to be tested.

Extends: oval-def:ObjectType

Child Elements

Elements
Child Elements Type (MinOccurs..MaxOccurs) Desc.
name oval-def:EntityObjectStringType (1..1) The name of the ACL.
ip_version iosxe-def:EntityObjectAccessListIPVersionType (1..1) The IP version of the ACL.
oval-def:filter n/a (0..unbounded)  

< acl_state >

The acl_state element defines the different information that can be used to evaluate the result of a specific ACL configuration. This includes the name of ths ACL and the corresponding config lines. Please refer to the individual elements in the schema for more details about what each represents.

Extends: oval-def:StateType

Child Elements

Elements
Child Elements Type (MinOccurs..MaxOccurs) Desc.
name oval-def:EntityStateStringType (0..1) The name of the ACL.
ip_version iosxe-def:EntityStateAccessListIPVersionType (0..1) The IP version of the ACL.
use iosxe-def:EntityStateAccessListUseType (0..1) The feature where the ACL is used.
used_in oval-def:EntityStateStringType (0..1) The name of where the ACL is used. For example if use is ‘INTERFACE’, use_in will be the name of the interface.
interface_direction iosxe-def:EntityStateAccessListInterfaceDirectionType (0..1) The direction the ACL is applied on an interface.
acl_config_lines oval-def:EntityStateStringType (0..1) The value returned with all config lines of the ACL.
config_line oval-def:EntityStateStringType (0..1) The value returned with one ACL config line at a time.

< snmphost_test >

The snmphost test is used to check the properties of specific output lines from an SNMP configuration.

Extends: oval-def:TestType

Child Elements

Elements
Child Elements Type (MinOccurs..MaxOccurs) Desc.
object oval-def:ObjectRefType (1..1)  
state oval-def:StateRefType (0..unbounded)  

< snmphost_object >

The snmphost_object element is used by an snmphost test to define the object to be evaluated. Each object extends the standard ObjectType as defined in the oval-definitions-schema and one should refer to the ObjectType description for more information. The common set element allows complex objects to be created using filters and set logic. Again, please refer to the description of the set element in the oval-definitions-schema.

A snmphost object consists of a host entity that is the host of the ‘snmp host’ IOS-XE command to be tested.

Extends: oval-def:ObjectType

Child Elements

Elements
Child Elements Type (MinOccurs..MaxOccurs) Desc.
host oval-def:EntityObjectStringType (1..1) The SNMP host address or hostname.
oval-def:filter n/a (0..unbounded)  

< snmphost_state >

The snmphost_state element defines the different information that can be used to evaluate the result of a specific ‘snmp host’ IOS-XE command. This includes the host and the corresponding options. Please refer to the individual elements in the schema for more details about what each represents.

Extends: oval-def:StateType

Child Elements

Elements
Child Elements Type (MinOccurs..MaxOccurs) Desc.
host oval-def:EntityStateStringType (0..1) The SNMP host address or hostname.
community_or_user oval-def:EntityStateStringType (0..1) The community string or SNMPv3 user configured for the host.
version iosxe-def:EntityStateSNMPVersionStringType (0..1) The SNMP version.
snmpv3_sec_level iosxe-def:EntityStateSNMPSecLevelStringType (0..1) The SNMPv3 security configured for the host.
traps oval-def:EntityStateStringType (0..1) The SNMP traps configured.

< snmpcommunity_test >

The snmpcommunity test is used to check the properties of specific output lines from an SNMP configuration.

Extends: oval-def:TestType

Child Elements

Elements
Child Elements Type (MinOccurs..MaxOccurs) Desc.
object oval-def:ObjectRefType (1..1)  
state oval-def:StateRefType (0..unbounded)  

< snmpcommunity_object >

The snmpcommunity_object element is used by an snmpcommunity test to define the object to be evaluated. Each object extends the standard ObjectType as defined in the oval-definitions-schema and one should refer to the ObjectType description for more information. The common set element allows complex objects to be created using filters and set logic. Again, please refer to the description of the set element in the oval-definitions-schema.

An snmpcommunity object consists of a community name entity to be tested.

Extends: oval-def:ObjectType

Child Elements

Elements
Child Elements Type (MinOccurs..MaxOccurs) Desc.
name oval-def:EntityObjectStringType (1..1) The SNMP community name.
oval-def:filter n/a (0..unbounded)  

< snmpcommunity_state >

The snmpcommunity_state element defines the different information that can be used to evaluate the result of a specific ‘snmp community’ IOS-XE command. This includes the community name and the corresponding options. Please refer to the individual elements in the schema for more details about what each represents.

Extends: oval-def:StateType

Child Elements

Elements
Child Elements Type (MinOccurs..MaxOccurs) Desc.
name oval-def:EntityStateStringType (0..1) The SNMP community name.
view oval-def:EntityStateStringType (0..1) The view that restricts the OIDs of this community.
mode iosxe-def:EntityStateSNMPModeStringType (0..1) The read-write privileges of the community.
ipv4_acl oval-def:EntityStateStringType (0..1) The IPv4 ACL name applied to the community.
ipv6_acl oval-def:EntityStateStringType (0..1) The IPv6 ACL name applied to the community.

< snmpuser_test >

The snmpuser test is used to check the properties of specific output lines from an SNMP user configuration.

Extends: oval-def:TestType

Child Elements

Elements
Child Elements Type (MinOccurs..MaxOccurs) Desc.
object oval-def:ObjectRefType (1..1)  
state oval-def:StateRefType (0..unbounded)  

< snmpuser_object >

The snmpuser_object element is used by an snmpuser test to define the object to be evaluated. Each object extends the standard ObjectType as defined in the oval-definitions-schema and one should refer to the ObjectType description for more information. The common set element allows complex objects to be created using filters and set logic. Again, please refer to the description of the set element in the oval-definitions-schema.

A snmpuser object consists of a name entity that is the name of the SNMP user to be tested.

Extends: oval-def:ObjectType

Child Elements

Elements
Child Elements Type (MinOccurs..MaxOccurs) Desc.
name oval-def:EntityObjectStringType (1..1) The SNMP user name.
oval-def:filter n/a (0..unbounded)  

< snmpuser_state >

The snmpuser_state element defines the different information that can be used to evaluate the result of a specific ‘show snmp user’ IOS-XE command. This includes the user name and the corresponding options. Please refer to the individual elements in the schema for more details about what each represents.

Extends: oval-def:StateType

Child Elements

Elements
Child Elements Type (MinOccurs..MaxOccurs) Desc.
name oval-def:EntityStateStringType (0..1) The SNMP user name.
group oval-def:EntityStateStringType (0..1) The SNMP group the user belongs to.
version iosxe-def:EntityStateSNMPVersionStringType (0..1) The SNMP version of the user.
ipv4_acl oval-def:EntityStateStringType (0..1) The IPv4 ACL name applied to the user.
ipv6_acl oval-def:EntityStateStringType (0..1) The IPv6 ACL name applied to the user.
priv iosxe-def:EntityStateSNMPPrivStringType (0..1) The SNMP encryption type for the user (for SNMPv3).
auth iosxe-def:EntityStateSNMPAuthStringType (0..1) The SNMP authentication type for the user (for SNMPv3).

< snmpgroup_test >

The snmpgroup test is used to check the properties of specific output lines from an SNMP group configuration.

Extends: oval-def:TestType

Child Elements

Elements
Child Elements Type (MinOccurs..MaxOccurs) Desc.
object oval-def:ObjectRefType (1..1)  
state oval-def:StateRefType (0..unbounded)  

< snmpgroup_object >

The snmpgroup_object element is used by an snmpgroup test to define the object to be evaluated. Each object extends the standard ObjectType as defined in the oval-definitions-schema and one should refer to the ObjectType description for more information. The common set element allows complex objects to be created using filters and set logic. Again, please refer to the description of the set element in the oval-definitions-schema.

A snmpgroup object consists of a name entity that is the name of the SNMP group to be tested.

Extends: oval-def:ObjectType

Child Elements

Elements
Child Elements Type (MinOccurs..MaxOccurs) Desc.
name oval-def:EntityObjectStringType (1..1) The SNMP group name.
oval-def:filter n/a (0..unbounded)  

< snmpgroup_state >

The snmpgroup_state element defines the different information that can be used to evaluate the result of a specific ‘snmp-server group’ IOS-XE command. This includes the user name and the corresponding options. Please refer to the individual elements in the schema for more details about what each represents.

Extends: oval-def:StateType

Child Elements

Elements
Child Elements Type (MinOccurs..MaxOccurs) Desc.
name oval-def:EntityStateStringType (0..1) The SNMP group name.
version iosxe-def:EntityStateSNMPVersionStringType (0..1) The SNMP version of the group.
snmpv3_sec_level iosxe-def:EntityStateSNMPSecLevelStringType (0..1) The SNMPv3 security configured for the group.
ipv4_acl oval-def:EntityStateStringType (0..1) The IPv4 ACL name applied to the group.
ipv6_acl oval-def:EntityStateStringType (0..1) The IPv6 ACL name applied to the group.
read_view oval-def:EntityStateStringType (0..1) The SNMP read view applied to the group.
write_view oval-def:EntityStateStringType (0..1) The SNMP write view applied to the group.
notify_view oval-def:EntityStateStringType (0..1) The SNMP notify view applied to the group.

< snmpview_test >

The snmpview test is used to check the properties of specific output lines from an SNMP view configuration.

Extends: oval-def:TestType

Child Elements

Elements
Child Elements Type (MinOccurs..MaxOccurs) Desc.
object oval-def:ObjectRefType (1..1)  
state oval-def:StateRefType (0..unbounded)  

< snmpview_object >

The snmpview_object element is used by an snmpview test to define the object to be evaluated. Each object extends the standard ObjectType as defined in the oval-definitions-schema and one should refer to the ObjectType description for more information. The common set element allows complex objects to be created using filters and set logic. Again, please refer to the description of the set element in the oval-definitions-schema.

A snmpview object consists of a name entity that is the name of the SNMP view to be tested.

Extends: oval-def:ObjectType

Child Elements

Elements
Child Elements Type (MinOccurs..MaxOccurs) Desc.
name oval-def:EntityObjectStringType (1..1) The SNMP view name.
oval-def:filter n/a (0..unbounded)  

< snmpview_state >

The snmpview_state element defines the different information that can be used to evaluate the result of a specific ‘snmp-server view’ IOS-XE command. This includes the view name and the corresponding options. Please refer to the individual elements in the schema for more details about what each represents.

Extends: oval-def:StateType

Child Elements

Elements
Child Elements Type (MinOccurs..MaxOccurs) Desc.
name oval-def:EntityStateStringType (0..1) The SNMP view name.
mib_family oval-def:EntityStateStringType (0..1) The SNMP MIB family of the view.
include oval-def:EntityStateBoolType (0..1) It is true if the included option is used in the view.

== EntityObjectAccessListIPVersionType ==

The EntityObjectAccessListIPVersionType 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 variable references. Note that when using pattern matches and variables care must be taken to ensure that the regular expression and variable values align with the enumerated values.

Restricts: oval-def:EntityObjectStringType

Enumeration Values
Value Description
IPV4 (No Description)
IPV6 (No Description)
 
The empty string value is permitted here to allow for empty elements associated with variable references.

== EntityObjectRoutingProtocolType ==

The EntityObjectRoutingProtocolType 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 variable references. Note that when using pattern matches and variables care must be taken to ensure that the regular expression and variable values align with the enumerated values.

Restricts: oval-def:EntityObjectStringType

Enumeration Values
Value Description
EIGRP (No Description)
OSPF (No Description)
BGP (No Description)
RIP (No Description)
RIPV2 (No Description)
ISIS (No Description)
 
The empty string value is permitted here to allow for empty elements associated with variable references.

== EntityStateTrunkEncapType ==

The EntityStateTrunkEncapType 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 variable references. Note that when using pattern matches and variables care must be taken to ensure that the regular expression and variable values align with the enumerated values.

Restricts: oval-def:EntityStateStringType

Enumeration Values
Value Description
DOT1Q (No Description)
ISL (No Description)
NEGOTIATE (No Description)
 
The empty string value is permitted here to allow for empty elements associated with variable references.

== EntityStateSwitchportModeType ==

The EntityStateSwitchportModeType 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 variable references. Note that when using pattern matches and variables care must be taken to ensure that the regular expression and variable values align with the enumerated values.

Restricts: oval-def:EntityStateStringType

Enumeration Values
Value Description
DYNAMIC (No Description)
TRUNK (No Description)
ACCESS (No Description)
 
The empty string value is permitted here to allow for empty elements associated with variable references.

== EntityStateRoutingProtocolType ==

The EntityStateRoutingProtocolType 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 variable references. Note that when using pattern matches and variables care must be taken to ensure that the regular expression and variable values align with the enumerated values.

Restricts: oval-def:EntityStateStringType

Enumeration Values
Value Description
EIGRP (No Description)
OSPF (No Description)
BGP (No Description)
RIP (No Description)
RIPV2 (No Description)
ISIS (No Description)
 
The empty string value is permitted here to allow for empty elements associated with variable references.

== EntityStateRoutingAuthTypeStringType ==

The EntityStateRoutingAuthTypeStringType complex type restricts a string value to a specific set of values: CLEARTEXT, MESSAGE_DIGEST. 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 variable references. Note that when using pattern matches and variables care must be taken to ensure that the regular expression and variable values align with the enumerated values.

Restricts: oval-def:EntityStateStringType

Enumeration Values
Value Description
CLEARTEXT (No Description)
MESSAGE_DIGEST (No Description)
NULL (Deprecated)

Deprecated As Of Version: 5.11.2:1.0
Reason: The NULL authentication area type is never declared in an interface ip ospf command context.
Comment: This RoutingAuthTypeStringType enumeration value has been deprecated and may be removed in a future version of the language.
 
The empty string value is permitted here to allow for empty elements associated with variable references.

== EntityStateSNMPVersionStringType ==

The EntityStateSNMPVersionStringType 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 variable references. Note that when using pattern matches and variables care must be taken to ensure that the regular expression and variable values align with the enumerated values.

Restricts: oval-def:EntityStateStringType

Enumeration Values
Value Description
1 (No Description)
2C (No Description)
3 (No Description)
 
The empty string value is permitted here to allow for empty elements associated with variable references.

== EntityStateSNMPSecLevelStringType ==

The EntityStateSNMPSecLevelStringType 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 variable references. Note that when using pattern matches and variables care must be taken to ensure that the regular expression and variable values align with the enumerated values.

Restricts: oval-def:EntityStateStringType

Enumeration Values
Value Description
PRIV (No Description)
AUTH (No Description)
NO_AUTH (No Description)
 
The empty string value is permitted here to allow for empty elements associated with variable references.

== EntityStateSNMPModeStringType ==

The EntityStateSNMPModeStringType 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 variable references. Note that when using pattern matches and variables care must be taken to ensure that the regular expression and variable values align with the enumerated values.

Restricts: oval-def:EntityStateStringType

Enumeration Values
Value Description
RO (No Description)
RW (No Description)
 
The empty string value is permitted here to allow for empty elements associated with variable references.

== EntityStateSNMPAuthStringType ==

The EntityStateSNMPAuthStringType 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 variable references. Note that when using pattern matches and variables care must be taken to ensure that the regular expression and variable values align with the enumerated values.

Restricts: oval-def:EntityStateStringType

Enumeration Values
Value Description
MD5 (No Description)
SHA (No Description)
 
The empty string value is permitted here to allow for empty elements associated with variable references.

== EntityStateSNMPPrivStringType ==

The EntityStateSNMPPrivStringType 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 variable references. Note that when using pattern matches and variables care must be taken to ensure that the regular expression and variable values align with the enumerated values.

Restricts: oval-def:EntityStateStringType

Enumeration Values
Value Description
DES (No Description)
3DES (No Description)
AES (No Description)
 
The empty string value is permitted here to allow for empty elements associated with variable references.

== EntityStateAccessListIPVersionType ==

The EntityStateAccessListIPVersionType 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 variable references. Note that when using pattern matches and variables care must be taken to ensure that the regular expression and variable values align with the enumerated values.

Restricts: oval-def:EntityStateStringType

Enumeration Values
Value Description
IPV4 (No Description)
IPV6 (No Description)
 
The empty string value is permitted here to allow for empty elements associated with variable references.

== EntityStateAccessListUseType ==

The EntityStateAccessListUseType complex type restricts a string value to a specific set of values: INTERFACE, CRYPTO_MAP_MATCH, CLASS_MAP_MATCH, ROUTE_MAP_MATCH, IGMP_FILTER, VTY. These values describe the ACL use in a Cisco IOS-XE configuration. The empty string is also allowed to support empty element associated with variable references. Note that when using pattern matches and variables care must be taken to ensure that the regular expression and variable values align with the enumerated values.

Restricts: oval-def:EntityStateStringType

Enumeration Values
Value Description
INTERFACE (No Description)
CRYPTO_MAP_MATCH (No Description)
CLASS_MAP_MATCH (No Description)
ROUTE_MAP_MATCH (No Description)
IGMP_FILTER (No Description)
VTY (No Description)
NONE (Deprecated)

Deprecated As Of Version: 5.11.2:1.0
Reason: The EntityStateSimpleBaseType check_existence attribute serves the same purpose as this enumeration value.
Comment: This AccessListUseType enumeration value has been deprecated and may be removed in a future version of the language.
 
The empty string value is permitted here to allow for empty elements associated with variable references.

== EntityStateAccessListInterfaceDirectionType ==

The EntityStateAccessListInterfaceDirectionType 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 variable references. Note that when using pattern matches and variables care must be taken to ensure that the regular expression and variable values align with the enumerated values.

Restricts: oval-def:EntityStateStringType

Enumeration Values
Value Description
IN (No Description)
OUT (No Description)
 
The empty string value is permitted here to allow for empty elements associated with variable references.