cisco_cli_commands / cisco_cli_commands.json
FraRy's picture
Populated syntax field
6743e20 verified
[
{
"command": "enable",
"description": "Switches the user from user EXEC mode to privileged EXEC mode, allowing access to more powerful administrative commands. Privileged EXEC mode is indicated by the `#` symbol in the prompt.",
"examples": [
{
"example_command": "enable",
"explanation": "Switches from user EXEC mode to privileged EXEC mode."
}
],
"syntax": [
"enable"
]
},
{
"command": "configure terminal",
"description": "Enters global configuration mode, which allows you to make changes to the device's configuration.",
"examples": [
{
"example_command": "configure terminal",
"explanation": "Enters global configuration mode to modify the device configuration."
}
],
"syntax": [
"configure terminal"
]
},
{
"command": "interface gigabitethernet/number",
"description": "Puts the device into interface configuration mode for the specified Gigabit Ethernet interface, allowing you to configure settings for that interface. For example, `interface gigabitethernet1/0/1`.",
"examples": [
{
"example_command": "interface gigabitethernet1/0/1",
"explanation": "Enters interface configuration mode for the GigabitEthernet1/0/1 interface."
}
],
"syntax": [
"interface gigabitethernet1/0/1"
]
},
{
"command": "reload",
"description": "Reboots the Cisco switch or router, reloading its running software and configuration.",
"examples": [
{
"example_command": "reload",
"explanation": "Reboots the device."
}
],
"syntax": [
"reload"
]
},
{
"command": "hostname name",
"description": "Sets the hostname for the current Cisco device. This hostname is used to identify the device on the network.",
"examples": [
{
"example_command": "hostname Switch01",
"explanation": "Sets the hostname of the device to 'Switch01'."
}
],
"syntax": [
"hostname Switch01"
]
},
{
"command": "copy from-location to-location",
"description": "Copies files from one location to another on the Cisco device. For example, copying configuration files or IOS images between locations such as `flash:`, `tftp:`, or `nvram:`.",
"examples": [
{
"example_command": "copy running-config startup-config",
"explanation": "Saves the current running configuration to the startup configuration."
}
],
"syntax": [
"copy running-config startup-config"
]
},
{
"command": "copy running-config startup-config",
"description": "Saves the active configuration to the startup configuration file so that it is retained when the device is rebooted.",
"examples": [
{
"example_command": "copy running-config startup-config",
"explanation": "Saves the current active configuration to the startup configuration file."
}
],
"syntax": [
"copy running-config startup-config"
]
},
{
"command": "copy startup-config running-config",
"description": "Merges the startup configuration (stored in NVRAM) with the current running configuration (in RAM).",
"examples": [
{
"example_command": "copy startup-config running-config",
"explanation": "Merges the startup configuration with the current running configuration."
}
],
"syntax": [
"copy startup-config running-config"
]
},
{
"command": "write erase",
"description": "Erases the startup configuration file from NVRAM, effectively resetting the device to its factory settings.",
"examples": [
{
"example_command": "write erase",
"explanation": "Erases the startup configuration, resetting the device."
}
],
"syntax": [
"write erase"
]
},
{
"command": "ip address ip-address mask",
"description": "Assigns an IP address and subnet mask to an interface on the Cisco device.",
"examples": [
{
"example_command": "ip address 192.168.1.1 255.255.255.0",
"explanation": "Assigns the IP address 192.168.1.1 with a subnet mask of 255.255.255.0 to the interface."
}
],
"syntax": [
"ip address 192.168.1.1 255.255.255.0"
]
},
{
"command": "shutdown / no shutdown",
"description": "The `shutdown` command disables an interface, while `no shutdown` enables it.",
"examples": [
{
"example_command": "shutdown",
"explanation": "Disables the interface."
},
{
"example_command": "no shutdown",
"explanation": "Enables the interface."
}
],
"syntax": [
"shutdown",
"no shutdown"
]
},
{
"command": "ip default-gateway ip_address",
"description": "Configures the default gateway on the device, allowing it to send traffic to devices outside its local subnet.",
"examples": [
{
"example_command": "ip default-gateway 192.168.1.254",
"explanation": "Sets the default gateway to 192.168.1.254."
}
],
"syntax": [
"ip default-gateway 192.168.1.254"
]
},
{
"command": "ping {hostname | system-address}",
"description": "Sends Internet Control Message Protocol (ICMP) echo requests to a specified host or IP address to test network connectivity.",
"examples": [
{
"example_command": "ping 8.8.8.8",
"explanation": "Pings the Google DNS server (8.8.8.8) to check for network connectivity."
}
],
"syntax": [
"ping 8.8.8.8"
]
},
{
"command": "speed {10 | 100 | 1000 | auto}",
"description": "Sets the speed of a network interface. Speeds are in Mbps, or the `auto` option can be used to automatically detect the correct speed.",
"examples": [
{
"example_command": "speed 1000",
"explanation": "Sets the interface speed to 1000 Mbps (1 Gbps)."
}
],
"syntax": [
"speed 1000"
]
},
{
"command": "duplex {auto | full | half}",
"description": "Configures the duplex setting of a network interface. Duplex can be set to `full` for bidirectional communication, `half` for unidirectional, or `auto` for automatic detection.",
"examples": [
{
"example_command": "duplex full",
"explanation": "Sets the interface to full duplex mode."
}
],
"syntax": [
"duplex full"
]
},
{
"command": "cdp run / no cdp run",
"description": "Enables or disables Cisco Discovery Protocol (CDP) globally on the device.",
"examples": [
{
"example_command": "cdp run",
"explanation": "Enables Cisco Discovery Protocol globally on the device."
},
{
"example_command": "no cdp run",
"explanation": "Disables Cisco Discovery Protocol globally on the device."
}
],
"syntax": [
"cdp run",
"no cdp run"
]
},
{
"command": "show mac address-table",
"description": "Displays the MAC address table of the device, showing which MAC addresses are associated with which interfaces.",
"examples": [
{
"example_command": "show mac address-table",
"explanation": "Displays the MAC address table for all interfaces."
}
],
"syntax": [
"show mac address-table"
]
},
{
"command": "show ip route",
"description": "Displays the current IP routing table, listing known routes that are either statically configured or learned through dynamic routing protocols.",
"examples": [
{
"example_command": "show ip route",
"explanation": "Displays the current IP routing table."
}
],
"syntax": [
"show ip route"
]
},
{
"command": "ip route network-number network-mask {ip-address | interface}",
"description": "Creates a static route in the IP routing table. You can specify the destination network and subnet mask, along with either a next-hop IP address or the interface through which the traffic should be routed.",
"examples": [
{
"example_command": "ip route 10.1.1.0 255.255.255.0 192.168.1.1",
"explanation": "Configures a static route to the 10.1.1.0/24 network with a next-hop IP address of 192.168.1.1."
}
],
"syntax": [
"ip route 10.1.1.0 255.255.255.0 192.168.1.1"
]
},
{
"command": "switchport access vlan {vlan-id}",
"description": "Assigns a specific VLAN to the interface in access mode, allowing it to communicate within the VLAN.",
"examples": [
{
"example_command": "switchport access vlan 10",
"explanation": "Assigns VLAN 10 to the interface in access mode."
}
],
"syntax": [
"switchport access vlan 10"
]
},
{
"command": "switchport trunk encapsulation dot1q",
"description": "Sets 802.1Q encapsulation for a trunk port, allowing multiple VLANs to be carried over the trunk.",
"examples": [
{
"example_command": "switchport trunk encapsulation dot1q",
"explanation": "Sets 802.1Q encapsulation on the trunk port."
}
],
"syntax": [
"switchport trunk encapsulation dot1q"
]
},
{
"command": "enable password pass-value",
"description": "Sets the password required to enter privileged EXEC mode (the `enable` command).",
"examples": [
{
"example_command": "enable password cisco123",
"explanation": "Sets 'cisco123' as the password required to enter privileged EXEC mode."
}
],
"syntax": [
"enable password cisco123"
]
},
{
"command": "enable secret pass-value",
"description": "Sets a hashed, encrypted password for privileged EXEC mode access.",
"examples": [
{
"example_command": "enable secret mysecretpass",
"explanation": "Sets a hashed, encrypted password 'mysecretpass' for privileged EXEC mode."
}
],
"syntax": [
"enable secret mysecretpass"
]
},
{
"command": "service password-encryption",
"description": "Enables encryption for passwords stored in the configuration file.",
"examples": [
{
"example_command": "service password-encryption",
"explanation": "Encrypts all passwords in the device configuration file."
}
],
"syntax": [
"service password-encryption"
]
},
{
"command": "access-list access-list-number {deny | permit} source [source-wildcard]",
"description": "Defines an IP access list (ACL) with rules to either permit or deny traffic based on source addresses.",
"examples": [
{
"example_command": "access-list 10 permit 192.168.1.0 0.0.0.255",
"explanation": "Permits traffic from the 192.168.1.0/24 network."
}
],
"syntax": [
"access-list 10 permit 192.168.1.0 0.0.0.255"
]
},
{
"command": "ntp peer <ip-address>",
"description": "Configures the device to synchronize its clock with a specified NTP (Network Time Protocol) peer.",
"examples": [
{
"example_command": "ntp peer 192.168.1.100",
"explanation": "Configures the device to synchronize with NTP peer at 192.168.1.100."
}
],
"syntax": [
"ntp peer 192.168.1.100"
]
},
{
"command": "lldp run",
"description": "Enables LLDP (Link Layer Discovery Protocol) globally on the device. LLDP is a vendor-neutral protocol that allows devices to advertise their identity and capabilities to neighboring devices.",
"examples": [
{
"example_command": "lldp run",
"explanation": "Enables LLDP globally on the device."
}
],
"syntax": [
"lldp run"
]
},
{
"command": "show lldp neighbors",
"description": "Displays information about neighboring devices discovered using LLDP. The information can be displayed for all interfaces or for a specific interface.",
"syntax": [
"show lldp neighbors [ interface-id ]"
],
"examples": [
{
"example_command": "show lldp neighbors",
"explanation": "Displays a summary of neighboring devices discovered via LLDP on all interfaces."
},
{
"example_command": "show lldp neighbors gigabitethernet1/0/1",
"explanation": "Displays LLDP information for the neighboring device connected to interface GigabitEthernet1/0/1."
}
]
},
{
"command": "show lldp traffic",
"description": "Displays LLDP traffic statistics, including the number of transmitted and received LLDP packets, as well as any packet errors.",
"examples": [
{
"example_command": "show lldp traffic",
"explanation": "Displays LLDP traffic statistics for the device."
}
],
"syntax": [
"show lldp traffic"
]
},
{
"command": "no lldp run",
"description": "Disables LLDP globally on the device, preventing it from advertising or listening for neighboring devices.",
"examples": [
{
"example_command": "no lldp run",
"explanation": "Disables LLDP globally on the device."
}
],
"syntax": [
"no lldp run"
]
},
{
"command": "show cdp neighbors",
"description": "Displays information about neighboring devices discovered using CDP (Cisco Discovery Protocol). It shows the device ID, local interface, holdtime, capability, platform, and port ID of the connected neighbors.",
"examples": [
{
"example_command": "show cdp neighbors",
"explanation": "Displays a summary of neighboring devices discovered via CDP."
}
],
"syntax": [
"show cdp neighbors"
]
},
{
"command": "show interfaces status",
"description": "Displays a summary of interface status, including speed, duplex, VLAN assignment, and operational state. It's useful for troubleshooting interface issues and verifying interface configurations.",
"examples": [
{
"example_command": "show interfaces status",
"explanation": "Displays the status of all interfaces on the device."
}
],
"syntax": [
"show interfaces status"
]
},
{
"command": "show interfaces switchport",
"description": "Displays detailed information about the switchport settings of an interface, including VLAN and trunking information.",
"examples": [
{
"example_command": "show interfaces switchport gigabitethernet1/0/1",
"explanation": "Displays detailed switchport information for the interface GigabitEthernet1/0/1."
}
],
"syntax": [
"show interfaces switchport gigabitethernet1/0/1"
]
}
]