{ "content": [ { "type": "text", "text": "# ip-neighbour (man)\n\n## NAME\n\nip-neighbour - neighbour/arp tables management.\n\n## SYNOPSIS\n\nip [ OPTIONS ] neigh { COMMAND | help }\nip neigh { add | del | change | replace } { ADDR [ lladdr LLADDR ] [ nud STATE ] | proxy ADDR\n} [ dev DEV ] [ router ] [ externlearn ]\nip neigh { show | flush } [ proxy ] [ to PREFIX ] [ dev DEV ] [ nud STATE ] [ vrf NAME ]\nip neigh get ADDR dev DEV\nSTATE := { permanent | noarp | stale | reachable | none | incomplete | delay | probe | failed\n}\n\n## DESCRIPTION\n\nThe ip neigh command manipulates neighbour objects that establish bindings between protocol\naddresses and link layer addresses for hosts sharing the same link. Neighbour entries are\norganized into tables. The IPv4 neighbour table is also known by another name - the ARP ta‐\nble.\n\n## TLDR\n\n> This command is an alias of `ip neighbor`.\n\n- View documentation for the original command:\n `tldr ip neighbor`\n\n*Source: tldr-pages*\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **EXAMPLES**\n- **SEE ALSO**\n- **AUTHOR**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n" } ], "structuredContent": { "command": "ip-neighbour", "section": "", "mode": "man", "summary": "ip-neighbour - neighbour/arp tables management.", "synopsis": "ip [ OPTIONS ] neigh { COMMAND | help }\nip neigh { add | del | change | replace } { ADDR [ lladdr LLADDR ] [ nud STATE ] | proxy ADDR\n} [ dev DEV ] [ router ] [ externlearn ]\nip neigh { show | flush } [ proxy ] [ to PREFIX ] [ dev DEV ] [ nud STATE ] [ vrf NAME ]\nip neigh get ADDR dev DEV\nSTATE := { permanent | noarp | stale | reachable | none | incomplete | delay | probe | failed\n}", "tldr_summary": "This command is an alias of `ip neighbor`.", "tldr_examples": [ { "description": "View documentation for the original command", "command": "tldr ip neighbor" } ], "tldr_source": "official", "flags": [], "examples": [ "ip neighbour", "Shows the current neighbour table in kernel.", "ip neigh flush dev eth0", "Removes entries in the neighbour table on device eth0.", "ip neigh get 10.0.1.10 dev eth0", "Performs a neighbour lookup in the kernel and returns a neighbour entry." ], "see_also": [ { "name": "ip", "section": "8", "url": "https://www.chedong.com/phpMan.php/man/ip/8/json" } ], "section_outline": [ { "name": "NAME", "lines": 2, "subsections": [] }, { "name": "SYNOPSIS", "lines": 14, "subsections": [] }, { "name": "DESCRIPTION", "lines": 146, "subsections": [] }, { "name": "EXAMPLES", "lines": 10, "subsections": [] }, { "name": "SEE ALSO", "lines": 3, "subsections": [] }, { "name": "AUTHOR", "lines": 5, "subsections": [] } ], "sections": { "NAME": { "content": "ip-neighbour - neighbour/arp tables management.\n", "subsections": [] }, "SYNOPSIS": { "content": "ip [ OPTIONS ] neigh { COMMAND | help }\n\n\nip neigh { add | del | change | replace } { ADDR [ lladdr LLADDR ] [ nud STATE ] | proxy ADDR\n} [ dev DEV ] [ router ] [ externlearn ]\n\nip neigh { show | flush } [ proxy ] [ to PREFIX ] [ dev DEV ] [ nud STATE ] [ vrf NAME ]\n\nip neigh get ADDR dev DEV\n\nSTATE := { permanent | noarp | stale | reachable | none | incomplete | delay | probe | failed\n}\n\n", "subsections": [] }, "DESCRIPTION": { "content": "The ip neigh command manipulates neighbour objects that establish bindings between protocol\naddresses and link layer addresses for hosts sharing the same link. Neighbour entries are\norganized into tables. The IPv4 neighbour table is also known by another name - the ARP ta‐\nble.\n\n\nThe corresponding commands display neighbour bindings and their properties, add new neighbour\nentries and delete old ones.\n\n\nip neighbour add\nadd a new neighbour entry\n\nip neighbour change\nchange an existing entry\n\nip neighbour replace\nadd a new entry or change an existing one\n\nThese commands create new neighbour records or update existing ones.\n\n\nto ADDRESS (default)\nthe protocol address of the neighbour. It is either an IPv4 or IPv6 address.\n\n\ndev NAME\nthe interface to which this neighbour is attached.\n\n\nproxy indicates whether we are proxying for this neighbour entry\n\n\nrouter indicates whether neighbour is a router\n\n\nexternlearn\nthis neigh entry was learned externally. This option can be used to indicate to\nthe kernel that this is a controller learnt dynamic entry. Kernel will not gc\nsuch an entry.\n\n\nlladdr LLADDRESS\nthe link layer address of the neighbour. LLADDRESS can also be null.\n\n\nnud STATE\nthe state of the neighbour entry. nud is an abbreviation for 'Neighbour Un‐\nreachability Detection'. The state can take one of the following values:\n\n\npermanent\nthe neighbour entry is valid forever and can be only be removed adminis‐\ntratively.\n\nnoarp the neighbour entry is valid. No attempts to validate this entry will be\nmade but it can be removed when its lifetime expires.\n\nreachable\nthe neighbour entry is valid until the reachability timeout expires.\n\nstale the neighbour entry is valid but suspicious. This option to ip neigh\ndoes not change the neighbour state if it was valid and the address is\nnot changed by this command.\n\nnone this is a pseudo state used when initially creating a neighbour entry or\nafter trying to remove it before it becomes free to do so.\n\nincomplete\nthe neighbour entry has not (yet) been validated/resolved.\n\ndelay neighbor entry validation is currently delayed.\n\nprobe neighbor is being probed.\n\nfailed max number of probes exceeded without success, neighbor validation has\nultimately failed.\n\n\nip neighbour delete\ndelete a neighbour entry\n\nThe arguments are the same as with ip neigh add, except that lladdr and nud are ig‐\nnored.\n\n\nWarning: Attempts to delete or manually change a noarp entry created by the kernel may\nresult in unpredictable behaviour. Particularly, the kernel may try to resolve this\naddress even on a NOARP interface or if the address is multicast or broadcast.\n\n\nip neighbour show\nlist neighbour entries\n\nto ADDRESS (default)\nthe prefix selecting the neighbours to list.\n\n\ndev NAME\nonly list the neighbours attached to this device.\n\n\nvrf NAME\nonly list the neighbours for given VRF.\n\n\nproxy list neighbour proxies.\n\n\nunused only list neighbours which are not currently in use.\n\n\nnud STATE\nonly list neighbour entries in this state. NUDSTATE takes values listed below\nor the special value all which means all states. This option may occur more\nthan once. If this option is absent, ip lists all entries except for none and\nnoarp.\n\n\nip neighbour flush\nflush neighbour entries\nThis command has the same arguments as show. The differences are that it does not run\nwhen no arguments are given, and that the default neighbour states to be flushed do\nnot include permanent and noarp.\n\n\nWith the -statistics option, the command becomes verbose. It prints out the number of\ndeleted neighbours and the number of rounds made to flush the neighbour table. If the\noption is given twice, ip neigh flush also dumps all the deleted neighbours.\n\n\nip neigh get\nlookup a neighbour entry to a destination given a device\n\n\nproxy indicates whether we should lookup a proxy neighbour entry\n\n\nto ADDRESS (default)\nthe prefix selecting the neighbour to query.\n\n\ndev NAME\nget neighbour entry attached to this device.\n\n", "subsections": [] }, "EXAMPLES": { "content": "ip neighbour\nShows the current neighbour table in kernel.\n\nip neigh flush dev eth0\nRemoves entries in the neighbour table on device eth0.\n\nip neigh get 10.0.1.10 dev eth0\nPerforms a neighbour lookup in the kernel and returns a neighbour entry.\n\n", "subsections": [] }, "SEE ALSO": { "content": "ip(8)\n\n", "subsections": [] }, "AUTHOR": { "content": "Original Manpage by Michail Litvak \n\n\n\niproute2 20 Dec 2011 IP-NEIGHBOUR(8)", "subsections": [] } } } }