Skip to content

Add new Cisco resources to the docs #817

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 14, 2025
Merged

Add new Cisco resources to the docs #817

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/actions/spelling/expect.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -325,6 +325,7 @@ uksouth
unicode
unversioned
uppercasing
urpf
usb
UXd
VALUEX
Expand Down
17 changes: 17 additions & 0 deletions .github/actions/spelling/line_forbidden.patterns
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,23 @@
# s.b. openEuler
\bOpen[Ee]uler\b

# s.b. OpenWrt
\b[Oo]penWRT\b

# s.b. SUSE Linux Micro
\bSLES Micro OS\b
\bSLES Micro\b

# s.b. DragonFly BSD
\bDragon[Ff]lyBSD\b
\bDragonfly BSD\b

# s.b. PLCnext
\bPLCNext\b

# s.b. SteamOS
\bSteam OS\b

# s.b. Smart Net Total Care
\bSMARTnet\b

Expand Down
194 changes: 107 additions & 87 deletions docs/mql/resources/networkdevices-pack/README.md
View file
Open in desktop

Large diffs are not rendered by default.

19 changes: 19 additions & 0 deletions docs/mql/resources/networkdevices-pack/cisco.iosxe.bootpconfig.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
title: cisco.iosxe.bootpConfig
id: cisco.iosxe.bootpConfig
sidebar_label: cisco.iosxe.bootpConfig
displayed_sidebar: MQL
description: Cisco IOS XE BootP configuration
---

# cisco.iosxe.bootpConfig

**Description**

Cisco IOS XE BootP configuration

**Fields**

| ID | TYPE | DESCRIPTION |
| ------- | ---- | ------------------ |
| enabled | bool | BOOTP enabled flag |
19 changes: 19 additions & 0 deletions docs/mql/resources/networkdevices-pack/cisco.iosxe.cdpconfig.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
title: cisco.iosxe.cdpConfig
id: cisco.iosxe.cdpConfig
sidebar_label: cisco.iosxe.cdpConfig
displayed_sidebar: MQL
description: Cisco IOS XE CDP configuration
---

# cisco.iosxe.cdpConfig

**Description**

Cisco IOS XE CDP configuration

**Fields**

| ID | TYPE | DESCRIPTION |
| ------- | ---- | ---------------- |
| enabled | bool | CDP enabled flag |
16 changes: 8 additions & 8 deletions docs/mql/resources/networkdevices-pack/cisco.iosxe.config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ Cisco IOS XE Global configuration settings

**Fields**

| ID | TYPE | DESCRIPTION |
| -------------------------------- | ------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ------------------------------------ |
| enablePassword | [cisco.iosxe.passwordEncryption](cisco.iosxe.passwordencryption.md) | The enable password configuration. Obtained by running 'show running-config | include enable password'. |
| enableSecret | [cisco.iosxe.passwordEncryption](cisco.iosxe.passwordencryption.md) | The enable secret configuration. Obtained by running 'show running-config | include enable secret'. |
| servicePasswordEncryptionEnabled | bool | Whether service password-encryption is enabled. Obtained by running 'show running-config | include service password-encryption' |
| execBanner | string | The exec banner, obtained by running 'show running-config | beg banner exec' |
| motdBanner | string | The message of the day banner, obtained by running 'show running-config | beg banner motd' |
| loginBanner | string | The login banner, obtained by running 'show running-config | beg banner login' |
| ID | TYPE | DESCRIPTION |
| -------------- | ------------------------------------------------------------------- | -------------------------------------------------------------------------------- | ------------------------- |
| service | [cisco.iosxe.serviceConfig](cisco.iosxe.serviceconfig.md) | The service configuration settings. Obtained by running 'show running-config all | include service' |
| enablePassword | [cisco.iosxe.passwordEncryption](cisco.iosxe.passwordencryption.md) | The enable password configuration. Obtained by running 'show running-config | include enable password'. |
| enableSecret | [cisco.iosxe.passwordEncryption](cisco.iosxe.passwordencryption.md) | The enable secret configuration. Obtained by running 'show running-config | include enable secret'. |
| execBanner | string | The exec banner, obtained by running 'show running-config | beg banner exec' |
| motdBanner | string | The message of the day banner, obtained by running 'show running-config | beg banner motd' |
| loginBanner | string | The login banner, obtained by running 'show running-config | beg banner login' |
23 changes: 23 additions & 0 deletions docs/mql/resources/networkdevices-pack/cisco.iosxe.cryptokeyrsa.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: cisco.iosxe.cryptoKeyRsa
id: cisco.iosxe.cryptoKeyRsa
sidebar_label: cisco.iosxe.cryptoKeyRsa
displayed_sidebar: MQL
description: Cisco IOS XR Router public key from `show crypto key mypubkey rsa`
---

# cisco.iosxe.cryptoKeyRsa

**Description**

Cisco IOS XR Router public key from `show crypto key mypubkey rsa`

**Fields**

| ID | TYPE | DESCRIPTION |
| ------------ | ------ | ------------------------------------- |
| label | string | Key label |
| keyType | string | Key type (e.g., RSA) |
| modulusSize | int | Key modulus size in bits (e.g., 2048) |
| creationDate | time | Key creation date |
| usage | string | Key usage (e.g. General purpose key) |
19 changes: 19 additions & 0 deletions docs/mql/resources/networkdevices-pack/cisco.iosxe.dhcpconfig.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
title: cisco.iosxe.dhcpConfig
id: cisco.iosxe.dhcpConfig
sidebar_label: cisco.iosxe.dhcpConfig
displayed_sidebar: MQL
description: Cisco IOS XE DHCP configuration
---

# cisco.iosxe.dhcpConfig

**Description**

Cisco IOS XE DHCP configuration

**Fields**

| ID | TYPE | DESCRIPTION |
| ------- | ---- | ----------------- |
| enabled | bool | DHCP enabled flag |
20 changes: 20 additions & 0 deletions docs/mql/resources/networkdevices-pack/cisco.iosxe.domainname.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: cisco.iosxe.domainName
id: cisco.iosxe.domainName
sidebar_label: cisco.iosxe.domainName
displayed_sidebar: MQL
description: Cisco IOS XE default domain name used to complete unqualified hostnames.
---

# cisco.iosxe.domainName

**Description**

Cisco IOS XE default domain name used to complete unqualified hostnames.

**Fields**

| ID | TYPE | DESCRIPTION |
| ------- | ------ | -------------------------------------------------------------------------------------------------------------------- |
| name | string | The name of the domain. |
| vrfName | string | Optional. When specified, the domain name applies to queries only in the virtual routing and forwarding (VRF) table. |
23 changes: 23 additions & 0 deletions docs/mql/resources/networkdevices-pack/cisco.iosxe.interfaceconfig.eigrpconfig.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: cisco.iosxe.interfaceConfig.eigrpConfig
id: cisco.iosxe.interfaceConfig.eigrpConfig
sidebar_label: cisco.iosxe.interfaceConfig.eigrpConfig
displayed_sidebar: MQL
description: Cisco IOS XE Interface EIGRP configuration
---

# cisco.iosxe.interfaceConfig.eigrpConfig

**Description**

Cisco IOS XE Interface EIGRP configuration

**Fields**

| ID | TYPE | DESCRIPTION |
| --------------------- | --------------------------------------------------------------- | ------------------------------------------------------------------------ |
| eigrpNumber | string | The EIGRP autonomous system number (name). |
| routerEigrp | [cisco.iosxe.routerEigrpEntry](cisco.iosxe.routereigrpentry.md) | The router EIGRP entry associated to this interface EIGRP configuration. |
| keychainName | string | Optional. The EIGRP authentication key chain name. |
| keychain | [cisco.iosxe.keyChain](cisco.iosxe.keychain.md) | Optional. The key chain used for authentication. |
| md5AuthenticationMode | bool | MD5 authentication enabled flag. |
19 changes: 11 additions & 8 deletions docs/mql/resources/networkdevices-pack/cisco.iosxe.interfaceconfig.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,14 @@ Cisco IOS XE Interface configuration

**Fields**

| ID | TYPE | DESCRIPTION |
| --------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------- |
| name | string | The name of the interface the configuration settings relate to. |
| proxyArpEnabled | bool | Whether the proxy ARP service is enabled on the interface. |
| aclInboundName | string | Optional. The name of the ACL applied to incoming traffic on the interface. |
| aclInbound | [cisco.iosxe.accessListEntry](cisco.iosxe.accesslistentry.md) | Optional. The inbound ACL entry applied to the interface. |
| aclOutboundName | string | Optional. The name of the ACL applied to outgoing traffic on the interface. |
| aclOutbound | [cisco.iosxe.accessListEntry](cisco.iosxe.accesslistentry.md) | Optional. The outbound ACL entry applied to the interface. |
| ID | TYPE | DESCRIPTION |
| --------------- | ----------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| name | string | The name of the interface the configuration settings relate to. |
| proxyArpEnabled | bool | Whether the proxy ARP service is enabled on the interface. |
| aclInboundName | string | Optional. The name of the ACL applied to incoming traffic on the interface. |
| aclInbound | [cisco.iosxe.accessListEntry](cisco.iosxe.accesslistentry.md) | Optional. The inbound ACL entry applied to the interface. |
| aclOutboundName | string | Optional. The name of the ACL applied to outgoing traffic on the interface. |
| aclOutbound | [cisco.iosxe.accessListEntry](cisco.iosxe.accesslistentry.md) | Optional. The outbound ACL entry applied to the interface. |
| urpf | [cisco.iosxe.interfaceConfig.urpf](cisco.iosxe.interfaceconfig.urpf.md) | The unicast reverse path forwarding (uRPF) configuration applied to the interface. |
| ipEigrpConfig | [][cisco.iosxe.interfaceConfig.eigrpConfig](cisco.iosxe.interfaceconfig.eigrpconfig.md) | Optional. The IP EIGRP configuration applied to the interface. |
| ospfConfig | [cisco.iosxe.interfaceConfig.ospfConfig](cisco.iosxe.interfaceconfig.ospfconfig.md) | Optional. The IP OSPF configuration applied to the interface. |
19 changes: 19 additions & 0 deletions docs/mql/resources/networkdevices-pack/cisco.iosxe.interfaceconfig.ospfconfig.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
title: cisco.iosxe.interfaceConfig.ospfConfig
id: cisco.iosxe.interfaceConfig.ospfConfig
sidebar_label: cisco.iosxe.interfaceConfig.ospfConfig
displayed_sidebar: MQL
description: Cisco IOS XE Interface OSPF configuration
---

# cisco.iosxe.interfaceConfig.ospfConfig

**Description**

Cisco IOS XE Interface OSPF configuration

**Fields**

| ID | TYPE | DESCRIPTION |
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- |
| messageDigestKeys | [][cisco.iosxe.interfaceConfig.ospfConfig.messageDigestKey](cisco.iosxe.interfaceconfig.ospfconfig.messagedigestkey.md) | A collection of OSPF md5 message digest keys. |
21 changes: 21 additions & 0 deletions .../networkdevices-pack/cisco.iosxe.interfaceconfig.ospfconfig.messagedigestkey.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: cisco.iosxe.interfaceConfig.ospfConfig.messageDigestKey
id: cisco.iosxe.interfaceConfig.ospfConfig.messageDigestKey
sidebar_label: cisco.iosxe.interfaceConfig.ospfConfig.messageDigestKey
displayed_sidebar: MQL
description: Cisco IOS XE Interface OSPF MD5 message digest key
---

# cisco.iosxe.interfaceConfig.ospfConfig.messageDigestKey

**Description**

Cisco IOS XE Interface OSPF MD5 message digest key

**Fields**

| ID | TYPE | DESCRIPTION |
| -------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------ |
| id | int | An identifier in the range 1 to 255. |
| encryptionType | string | Specifies the encryption level. The range is from 0 to 7., 0 specifies no encryption. 7 specifies a proprietary level of encryption. |
| keyString | string | The key string value. |
23 changes: 23 additions & 0 deletions docs/mql/resources/networkdevices-pack/cisco.iosxe.interfaceconfig.urpf.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: cisco.iosxe.interfaceConfig.urpf
id: cisco.iosxe.interfaceConfig.urpf
sidebar_label: cisco.iosxe.interfaceConfig.urpf
displayed_sidebar: MQL
description: Cisco IOS XE unicast reverse path forwarding (uRPF) setting applied to the interface.
---

# cisco.iosxe.interfaceConfig.urpf

**Description**

Cisco IOS XE unicast reverse path forwarding (uRPF) setting applied to the interface.

**Fields**

| ID | TYPE | DESCRIPTION |
| -------------------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| enabled | bool | Whether uRPF is enabled on the interface. |
| mode | string | Optional. When uRPF is enabled, the uRPF mode used to examine incoming packets. Can be `any` (loose) or `rx` (strict). |
| sourceBindingEnabled | bool | Optional. When uRPF is enabled, whether the source IPv4 and MAC address binding is enabled. |
| allowDefault | bool | Optional. Whether the use of the default route is used for verification. |
| allowSelfPing | bool | Optional. When uRPF is enabled, whether a router is allowed to ping its own interfaces., Use caution when enabling this setting because it opens a denial-of-service (DoS) hole. |
Loading
Loading